watir-or 0.0.4 → 1.0.0

data/lib/watir-or.rb

@@ -1,9 +1,5 @@
-Dir[File.join(File.dirname(__FILE__), "watir-or/converters") + "/*.rb"].each { |converter|
-  require converter
-}
+require File.join(File.dirname(__FILE__), 'watir-or/readers/xls')
+require File.join(File.dirname(__FILE__), 'watir-or/readers/xml')
 
-Dir[File.join(File.dirname(__FILE__), "watir-or/readers") + "/*.rb"].each { |reader|
-  require reader
-}
-require 'watir-or/element'
-require 'watir-or/repository'
+require File.join(File.dirname(__FILE__), 'watir-or/element')
+require File.join(File.dirname(__FILE__), 'watir-or/repository')

data/lib/watir-or/element.rb

@@ -1,71 +1,65 @@
 module ObjectRepository
   class RepositoryElement
-    attr_reader :rep_id, :type, :description
+    attr_reader :name
 
-    def initialize(rep_id, type, hows, whats, description, repository)
-      @rep_id = rep_id.dup
-      @description = description #.dup
-      @type = type.dup
-      @hows, @whats = hows.dup, whats.dup
+    def initialize(name, repository, &block)
+      @name = name 
       @repository = repository
+      instance_eval &block
     end
 
     def inspect
-      "Element #{@rep_id.inspect}:\n\thows: #{@hows.inspect}\n\twhats: #{@whats.inspect}\n\tdescription: #{@description.inspect}\n"
+      "Element #{@name.inspect}"
     end
 
     def ==(other)
-      @rep_id == other.rep_id && @type == other.type && @description == other.description
+      @name == other.name
     end
   end
 
   class WatirElement < RepositoryElement
-    include WatirObjectBuilder
-    attr_reader :watir_obj, :locator
-
-    def initialize(id, type, hows, whats, description, repository)
-      super(id, type, hows, whats, description, repository)
-      transform_whats!
-      @locator = Hash[*@hows.zip(@whats).flatten]
+    def locate(&block)
+      if block_given?
+        @locate_block = block
+      end
     end
 
     def method_missing(meth_name, *args, &block)
-      @watir_obj ||= WatirObjectBuilder.build_watir_obj(@repository, self)
-      if @watir_obj.respond_to?(meth_name) || meth_name.to_s.include?("_no_wait")
-        @watir_obj.send(meth_name, *args, &block)
-      else
-        super
-      end
+      @locate_block.call(@repository).send(meth_name, *args, &block)
     end
 
     def present?
       method_missing(:present?)
     end
-
-    private
-
-    def transform_whats!
-      @hows.each_with_index do |how, index|
-        if how == :index
-          @whats[index] = @whats[index].to_i
-        elsif @whats[index] =~ /^\/(.*)\/$/ && how != :xpath
-          @whats[index] = Regexp.new($1)
-        end
-      end
-    end
   end
 
   class CustomElement < RepositoryElement
     def initialize(*args)
-      super(*args)
       @attributes = {}
-      @hows.each_with_index do |how, index|
-        @attributes[how] = @repository.get_by_rep_id(@whats[index])
+      super(*args)
+    end
+
+    def field(name, field_name = nil, &block)
+      if block_given?
+        @attributes[name] = block
+        return
+      end
+
+      if field_name 
+        @attributes[name] = field_name 
+      else
+        get_field(name)
       end
     end
 
-    def field(name)
-      @attributes[name]
+    private
+
+    def get_field(name)
+      if @attributes[name].is_a?(String)
+        @repository.get(@attributes[name])
+      else
+        @attributes[name].call(@repository)
+      end
     end
   end
-end
+end

data/lib/watir-or/readers/xls.rb

@@ -19,27 +19,21 @@ module ObjectRepository
 
       def self.read_worksheet(worksheet, &block)
         rows_count = worksheet.row_count
-        hows = Array.new
-        whats = Array.new
-        rep_id = nil
-        description = nil
-        type = nil
         worksheet.each(1) { |row| # each(1) exclude header
-          unless row[0].nil?
-            hows.clear
-            whats.clear
-            rep_id = row[0]
-            type = row[1]
-            description = row[4]
-          end
-          hows << row[2]
-          whats << row[3]
           if (!worksheet.row(row.idx + 1)[0].nil? || row.idx + 1 >= rows_count )
-            yield rep_id, type, hows.map { |el| el.to_sym }, whats, description
+            name = row[0]
+            type = nil
+            locate_block = if row[2].nil?
+                             Proc.new { locate { |repository| eval(row[1]) } }
+                           else
+                             type = eval(row[2])
+                             Proc.new { |repository| eval(row[1]) } 
+                           end
+            yield name, type, locate_block
           end
         }
       end
     end
   end
 end
-  
+  

data/lib/watir-or/readers/xml.rb

@@ -5,19 +5,19 @@ module ObjectRepository
 
       def self.read(file, options = nil, &block)
         doc = Nokogiri::XML(File.read(file), nil, 'UTF-8', Nokogiri::XML::ParseOptions::NOBLANKS)
-        doc.root.xpath("//object").each { |node|
-          hows = node.search("./how").children
-          whats = hows.map { |h| h.content }
-          #Add parent
-          hows = hows.map { |h| h.name.to_sym  }
-          if node.parent != doc.root
-            hows << :parent
-            whats << node.parent['id']
-          end
-
-          yield node['id'], node['type'], hows, whats, node.search('./description').first.content
-        }
+        doc.root.xpath("//object").each do |node|
+          name = node['name']
+          type = nil
+          locate = node.search('./locate').first.content
+          locate_block = if node['type'].nil?
+                           Proc.new { locate { |repository| eval(locate) } }
+                         else
+                           type = eval(node['type'])
+                           Proc.new { |repository| eval(locate) } 
+                         end
+          yield name, type, locate_block
+        end
       end
     end
   end
-end
+end

data/lib/watir-or/repository.rb

@@ -5,7 +5,7 @@ module ObjectRepository
 
     def initialize(file, browser, options = nil)
       @file = file
-      @elements = Array.new
+      @elements = []
       @browser = browser
       @type = File.extname(@file).delete('.')
       fill_elements(options)
@@ -15,19 +15,12 @@ module ObjectRepository
       @elements.each { |el| yield el }
     end
 
-    def method_missing(meth_name, what, &block)
-      element = case meth_name.to_s
-      when /^get_by_(.*)/
-        find { |el| el.instance_variable_get("@#{$1.to_sym}") == what }
-      when "get"
-        find { |el| el.rep_id == what || el.description == what }
-      else
-        super
-      end
-      raise "Couldn't find repository element with #{what.inspect}" if element.nil?
+    def get(name)
+      element = find { |el| el.name == name }
+      raise "Couldn't find repository element with #{name.inspect}" if element.nil?
       return element
     end
-    
+
     def inspect
       @elements.inspect
     end
@@ -35,19 +28,30 @@ module ObjectRepository
     private
 
     def fill_elements(options)
-      eval("ObjectRepository::Reader::" + @type.upcase).read(@file, options) do |rep_id, type, hows, whats, description|
-        unless @elements.find { |el| el.rep_id == rep_id }
-          @elements << if type[0..0] =~ /[A-Z]/
-            eval("#{type}").new(rep_id, type, hows, whats, description, self)
-          else
-            WatirElement.new(rep_id, type, hows, whats, description, self)
-          end
-        else
-          raise "Duplicating of id: #{rep_id.inspect}"
-        end
+      reader_class = case @type.downcase
+      when 'xml' 
+        ObjectRepository::Reader::XML
+      when 'xls'
+        ObjectRepository::Reader::XLS
+      when 'rb'
+        instance_eval(File.read(file), file)
+        return
+      else
+        raise "Unknown type #{@type.inspect} of repository"
+      end
+
+      reader_class.read(@file, options) do |name, type, block|
+        element(name, type, &block)
+      end
+    end
+
+    def element(name, type = nil, &block)
+      raise "Duplicating of name: #{name.inspect}" if @elements.find { |el| el.name == name }
+      @elements << unless type
+        WatirElement.new(name, self, &block)
+      else
+        type.new(name, self, &block)
       end
-    rescue NameError      
-      raise "Unknown type #{@type.inspect} of repository"
     end
   end
-end
+end

data/spec/{browser_stub.rb → browser_mock.rb}

@@ -1,7 +1,6 @@
-class BrowserStub
+class BrowserMock
   def method_missing(meth_name, *args, &block)
     Control.new
-#    return "%s(%s)" % [meth_name, args.first.inspect.gsub(/(^\{|\}$)/, "")]
   end
 end
 
@@ -9,4 +8,4 @@ class Control
   def method_missing(meth_name, *args, &block)
     Control.new
   end
-end
+end

data/spec/custom_elements_spec.rb

@@ -1,21 +1,19 @@
 require 'lib/watir-or'
-require 'spec/browser_stub'
 require 'spec/spec_helper'
 TEST_FILE = "spec/test.xls"
 
 describe "CustomElement" do
   before(:all) do
-    @browser_stub = BrowserStub.new
+    @browser_stub = BrowserMock.new
     @repository = ObjectRepository::Repository.new(TEST_FILE, @browser_stub)
   end
 
   it "should return MyCustomElement object" do
-    @repository.get("custom element").should be_a(MyCustomElement)
+    @repository.get("Custom Element").should be_a(MyCustomElement)
   end
 
   it "should return field of MyCustomElement object" do
-    attr1 = ObjectRepository::RepositoryElement.new("one attribute", "text_field", [:name],
-        ["test"], "Element with one attribute", @repository)
-    @repository.get("custom element").field(:attr1).should == attr1
+    attr1 = ObjectRepository::WatirElement.new("Element with one attribute", @repository) { |block| block }
+    @repository.get("Custom Element").field(:attr1).should == attr1
   end
 end

data/spec/find_elements_spec.rb

@@ -1,36 +1,18 @@
 require 'lib/watir-or.rb'
-require 'spec/browser_stub'
 require 'spec/spec_helper'
 
 describe "Search of elements" do
   before(:all) do
-    @browser_stub = BrowserStub.new
+    @browser_stub = BrowserMock.new
     @repository = ObjectRepository::Repository.new("spec/test.xls", @browser_stub)
-    @element = ObjectRepository::RepositoryElement.new("many attributes", "select_list", [:text, :index],
-        ["test text", 1], "Element with many attributes", @repository)
+    @element = ObjectRepository::WatirElement.new("Element with many attributes", @repository) { }
   end
 
-  context "find element by id or description if argument is" do
-    it "id" do
-      @repository.get("many attributes").should == @element
-    end
-
-    it "description" do
-      @repository.get("Element with many attributes").should == @element
-    end
-  end
-
-  context "find by" do
-    it "id" do
-      @repository.get_by_rep_id("many attributes").should == @element
-    end
-
-    it "description" do
-      @repository.get_by_description("Element with many attributes").should == @element
-    end
+  it "find by name" do
+    @repository.get("Element with many attributes").should == @element
   end
 
   it "should raise exception when element wasn't found" do
     lambda{@repository.get("fake element")}.should raise_error
   end
-end
+end

data/spec/read_rb_spec.rb

@@ -0,0 +1,18 @@
+require 'lib/watir-or.rb'
+require 'spec/spec_helper'
+
+describe "Read xls-repository" do
+  before(:all) do
+    @repository = ObjectRepository::Repository.new("spec/test.rb", BrowserMock.new)
+  end
+
+  it "get watir element" do
+    one = ObjectRepository::WatirElement.new("Watir Element", @repository) { }
+    @repository.get("Watir Element").should == one
+  end
+
+  it "get custom element" do
+    custom = MyCustomElement.new("Custom Element", @repository) { }
+    @repository.get("Custom Element").should == custom
+  end
+end

data/spec/read_xls_spec.rb

@@ -2,58 +2,47 @@ require 'lib/watir-or.rb'
 require 'spec/spec_helper'
 
 describe "Read xls-repository" do
-  context "Read first worksheet" do
+  context "On first worksheet" do
     before(:all) do
-      @repository = ObjectRepository::Repository.new("spec/test.xls", BrowserStub.new)
+      @repository = ObjectRepository::Repository.new("spec/test.xls", BrowserMock.new)
     end
 
-    it "element with one attribute was readed" do
-      one = ObjectRepository::RepositoryElement.new("one attribute", "text_field", [:name],
-        ["test"], "Element with one attribute", @repository)
-      @repository.get("one attribute").should == one
+    it "get watir element" do
+      one = ObjectRepository::WatirElement.new("Element with many attributes", @repository) { }
+      @repository.get("Element with many attributes").should == one
     end
 
-    it "element with many attribute was readed" do
-      many = ObjectRepository::RepositoryElement.new("many attributes", "select_list", [:text, :index],
-        ["test text", 1], "Element with many attributes", @repository)
-      @repository.get("many attributes").should == many
-    end
-
-    it "last element with many attribute was readed" do
-      last_many = ObjectRepository::RepositoryElement.new("last element with many attributes", "image",
-        [:name, :src], ["xxx", "path"], "Last element with many attributes", @repository)
-      @repository.get("last element with many attributes").should == last_many
+    it "get custom element" do
+      custom = MyCustomElement.new("Custom Element", @repository) { }
+      @repository.get("Custom Element").should == custom
     end
   end
 
   context "Read special worksheet" do
     before(:all) do
-      @repository = ObjectRepository::Repository.new("spec/test.xls", BrowserStub.new, :worksheet => "special worksheet")
+      @repository = ObjectRepository::Repository.new("spec/test.xls", BrowserMock.new, :worksheet => "special worksheet")
     end
 
     it "should read element on special workheet" do
-      first = ObjectRepository::RepositoryElement.new("first element", "text_field",
-        [:name], ["awesome"], "First element on special worksheet", @repository)
-      @repository.get("first element").should == first
+      first = ObjectRepository::WatirElement.new("First element on special worksheet", @repository) { }
+      @repository.get("First element on special worksheet").should == first
     end
   end
 
   context "Read all worksheets" do
     before(:all) do
-      @repository = ObjectRepository::Repository.new("spec/test.xls", BrowserStub.new, :worksheet => :all)
+      @repository = ObjectRepository::Repository.new("spec/test.xls", BrowserMock.new, :worksheet => :all)
     end
 
     it "should read all elements on all workheets" do
-      on_first_worksheet = ObjectRepository::RepositoryElement.new("one attribute", "text_field", [:name],
-        ["test"], "Element with one attribute", @repository)
-      on_special_worksheet = ObjectRepository::RepositoryElement.new("first element", "text_field",
-        [:name], ["awesome"], "First element on special worksheet", @repository)
-      @repository.get("one attribute").should == on_first_worksheet
-      @repository.get("first element").should == on_special_worksheet
+      on_first_worksheet = ObjectRepository::WatirElement.new("Element with one attribute", @repository) { }
+      on_special_worksheet = ObjectRepository::WatirElement.new("First element on special worksheet", @repository) { }
+      @repository.get("Element with one attribute").should == on_first_worksheet
+      @repository.get("First element on special worksheet").should == on_special_worksheet
     end
   end
 
   it "duplicating of id" do
-      lambda { ObjectRepository::Repository.new("spec/test_duplicating_id.xls", BrowserStub.new) }.should raise_error
+      lambda { ObjectRepository::Repository.new("spec/test_duplicating_id.xls", BrowserMock.new) }.should raise_error
   end
-end
+end

data/spec/read_xml_spec.rb

@@ -3,24 +3,16 @@ require 'spec_helper'
 
 describe "Read xml-repository" do
   before(:all) do
-    @repository = ObjectRepository::Repository.new("spec/test.xml", BrowserStub.new)
+    @repository = ObjectRepository::Repository.new("spec/test.xml", BrowserMock.new)
   end
 
   it "element with one attribute was readed" do
-    one = ObjectRepository::RepositoryElement.new("one attribute", "text_field", [:name],
-      ["test"], "Element with one attribute", @repository)
-    @repository.get("one attribute").should == one
+    one = ObjectRepository::WatirElement.new("Element with one attribute", @repository) { }
+    @repository.get("Element with one attribute").should == one
   end
 
-  it "element with many attribute was readed" do
-    many = ObjectRepository::RepositoryElement.new("many attributes", "select_list", [:text, :index],
-      ["test text", 1], "Element with many attributes", @repository)
-    @repository.get("many attributes").should == many
+  it "custom element" do
+    custom = MyCustomElement.new("Custom Element", @repository) { }
+    @repository.get("Custom Element").should == custom 
   end
-
-  it "child element was readed" do
-    child = ObjectRepository::RepositoryElement.new("with parent", "div", [:index, :parent],
-      [3, "parent element"], "Element with parent", @repository)
-    @repository.get("with parent").should == child
-  end
-end
+end

data/spec/spec_helper.rb

@@ -1,4 +1,4 @@
-require 'browser_stub'
+require 'browser_mock'
 
 class MyCustomElement < ObjectRepository::CustomElement
-end
+end

data/spec/test.rb

@@ -0,0 +1,9 @@
+element "Watir Element" do
+  locate do |repository|
+    repository.browser.text_field(:name => "test")
+  end
+end
+
+element "Custom Element", MyCustomElement do
+  field :attr1, "Watir Element"
+end

data/spec/test.xml

@@ -1,35 +1,11 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <repository>
-    <object type="text_field" id="one attribute">
-        <how>
-            <name>test</name>
-        </how>
-        <description>Element with one attribute</description>
+    <object name="Element with one attribute">
+      <locate>reposiroty.browser.text_field(:name => "name")</locate>
     </object>
-    <object type="select_list" id="many attributes">
-        <how>
-            <text>test text</text>
-            <index>1</index>
-        </how>
-        <description>Element with many attributes</description>
+    <object type="MyCustomElement" name="Custom Element">
+        <locate>
+            field :attr1, "Element with one attribute"
+        </locate>
     </object>
-    <object type="div" id="parent element">
-        <how>
-            <index>1</index>
-        </how>
-        <description>Parent element</description>
-        <object type="div" id="with parent">
-            <how>
-                <index>3</index>
-            </how>
-            <description>Element with parent</description>
-        </object>
-    </object>
-    <object type="MyCustomElement" id="custom element">
-        <how>
-            <attr1>one attribute</attr1>
-            <attr2>many attributes</attr2>
-        </how>
-        <description>Custom Element</description>
-    </object>
-</repository>
+</repository>

metadata

@@ -3,10 +3,10 @@ name: watir-or
 version: !ruby/object:Gem::Version 
   prerelease: false
   segments: 
+  - 1
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  version: 1.0.0
 platform: ruby
 authors: 
 - Ivan Kabluchkov
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-16 00:00:00 +04:00
+date: 2011-06-29 00:00:00 +04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -59,25 +59,25 @@ extra_rdoc_files:
 files: 
 - README
 - Rakefile
-- lib/watir-or/converters/element_converter.rb
 - lib/watir-or/element.rb
 - lib/watir-or/readers/xls.rb
 - lib/watir-or/readers/xml.rb
 - lib/watir-or/repository.rb
 - lib/watir-or.rb
-- spec/browser_stub.rb
+- spec/browser_mock.rb
 - spec/custom_elements_spec.rb
 - spec/find_elements_spec.rb
+- spec/read_rb_spec.rb
 - spec/read_xls_spec.rb
 - spec/read_xml_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
+- spec/test.rb
 - spec/test.xls
 - spec/test.xml
 - spec/test_duplicating_id.xls
-- spec/watir_builder_spec.rb
 has_rdoc: true
-homepage: 
+homepage: https://github.com/lfidnl/watir-or
 licenses: []
 
 post_install_message: 
@@ -111,6 +111,6 @@ summary: Object Repository for Watir
 test_files: 
 - spec/custom_elements_spec.rb
 - spec/find_elements_spec.rb
+- spec/read_rb_spec.rb
 - spec/read_xls_spec.rb
 - spec/read_xml_spec.rb
-- spec/watir_builder_spec.rb

data/lib/watir-or/converters/element_converter.rb

@@ -1,27 +0,0 @@
-module ObjectRepository
-  module WatirObjectBuilder
-    def self.build_watir_obj(repository, rep_element)
-      eval("repository.browser.#{build_element(rep_element, repository)}")
-    end
-
-    def self.build_element(rep_element, repository)
-      parent = ""
-      unless rep_element.locator[:parent].nil?
-        parent = build_element(repository.find { |el| el.rep_id == rep_element.locator[:parent] }, repository) + "."
-      end
-      locator = rep_element.locator.dup
-      locator.delete(:parent)
-      parent << "%s(%s)" % [rep_element.type, build_locator(locator)]
-    end
-      
-    #Method need for separate frame(:name => "foo") and frame(:name, "foo").
-    #Because frame with multiply conditions doesn't work
-    def self.build_locator(locator)
-      if locator.length > 1
-        locator.inspect.gsub(/(^\{|\}$)/, "")
-      else
-        ":%s,%s" % [locator.keys.first, locator[locator.keys.first].inspect]
-      end
-    end
-  end
-end

data/spec/watir_builder_spec.rb

@@ -1,36 +0,0 @@
-require 'lib/watir-or.rb'
-require 'spec/browser_stub'
-require 'spec/spec_helper'
-
-describe "WatirObjectBuilder" do
-  before(:all) do
-    @browser_stub = BrowserStub.new
-    @repository = ObjectRepository::Repository.new("spec/test.xls", @browser_stub)
-  end
-
-  it "build watir object properly" do
-    element = @repository.get('many attributes')
-    built = ObjectRepository::WatirObjectBuilder.build_element(element, @repository)
-    built.should == 'select_list(:index=>1, :text=>"test text")'
-  end
-
-  it "build element with regexp" do
-    element = @repository.get('with regexp what')
-    built = ObjectRepository::WatirObjectBuilder.build_element(element, @repository)
-    built.should == 'text_field(:text,/regexp/)'
-  end
-
-  context "hierarchy" do
-    it "watir object which has one parent" do
-      element = @repository.get('with parent')
-      built = ObjectRepository::WatirObjectBuilder.build_element(element, @repository)
-      built.should == 'div(:index,1).div(:index,3)'
-    end
-
-    it "2 level" do
-      element = @repository.get('2 level hierarchy')
-      built = ObjectRepository::WatirObjectBuilder.build_element(element, @repository)
-      built.should == 'div(:index,1).div(:index,3).div(:index,5)'
-    end
-  end
-end