watir-or 0.0.2

data/README

@@ -0,0 +1,11 @@
+== Object Repository for WATiR
+
+This is a library for creating object repository for WATiR testing framework.
+
+== Installation
+
+gem install watir-or
+
+== Usage
+
+For more information see the http://github.com/lfidnl/watir-or/wiki

data/Rakefile

@@ -0,0 +1,30 @@
+# 
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+ 
+
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/testtask'
+require 'spec/rake/spectask'
+
+Rake::RDocTask.new do |rdoc|
+  files =['README', 'LICENSE', 'lib/**/*.rb']
+  rdoc.rdoc_files.add(files)
+  rdoc.main = "README" # page to start on
+  rdoc.title = "watir-or Docs"
+  rdoc.rdoc_dir = 'doc/rdoc' # rdoc output folder
+  rdoc.options << '--line-numbers'
+end
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/**/*.rb']
+end
+
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*.rb']
+  t.libs << Dir["lib"]
+end

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

@@ -0,0 +1,37 @@
+module ObjectRepository
+  module ElementConverter
+    module Watir
+      def self.convert(browser, repository, rep_element)
+        eval("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(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
+
+    def to_form_object(browser, repository)
+      if self.type[0, 1] =~ /[A-Z]/
+        eval(self.type).new(repository, browser, self.locator)
+      else
+        Watir.convert(browser, repository, self)
+      end
+    end
+  end
+end

data/lib/watir-or/element.rb

@@ -0,0 +1,31 @@
+module ObjectRepository
+  class RepositoryElement
+    include ElementConverter
+    attr_reader :id, :type, :locator, :description
+
+    def initialize(id, type, hows, whats, description)
+      @id = id
+      @description = description
+      @type = type
+      @locator = Hash[*hows.zip(whats).flatten]
+    end
+
+    def inspect
+      "Element #{@id.inspect}:\n\tlocator: #{@locator.inspect}\n\tdescription: #{@description.inspect}\n"
+    end
+
+    def ==(other)
+      @id == other.id && @type == other.type && @description == other.description && @locator == other.locator
+    end
+  end
+
+  class CustomElement
+    def initialize(repository, browser, attributes)
+      @repository, @browser, @attributes = repository, browser, attributes
+    end
+
+    def field(name)
+      @repository.get(@attributes[name])
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+module ObjectRepository
+  module Reader
+    module XLS
+      require 'spreadsheet'
+
+      def self.read(file, options = nil, &block)
+        if options.nil?
+          read_worksheet(Spreadsheet.open(file).worksheet(0), &block)
+        elsif options[:worksheet].is_a?(String)
+          read_worksheet(Spreadsheet.open(file).worksheet(options[:tab]), &block)
+        elsif options[:worksheet] == :all
+          Spreadsheet.open(file).worksheets.each { |worksheet|
+            read_worksheet(worksheet, &block)
+          }
+        end
+      end
+
+      private
+
+      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 << if row[2] == "index"
+            row[3].to_i
+          else
+            row[3]
+          end
+          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
+          end
+        }
+      end
+    end
+  end
+end
+  

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

@@ -0,0 +1,23 @@
+module ObjectRepository
+  module Reader
+    module XML
+      require 'nokogiri'
+
+      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.name == "index" ? h.content.to_i : 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
+        }
+      end
+    end
+  end
+end

data/lib/watir-or/repository.rb

@@ -0,0 +1,53 @@
+module ObjectRepository
+  class Repository
+    attr_reader :file, :browser, :elements
+
+    def initialize(file, browser, options = nil)
+      @file = file
+      @elements = Array.new
+      @browser = browser
+      @type = File.extname(@file).delete('.')
+      fill_elements(options)
+    end
+
+    def find(what, how = nil)
+      if how.nil?
+        element = @elements.find { |el| el.id == what || el.description == what }
+      else
+        element = @elements.find { |el| el.instance_variable_get("@#{how}") == what }
+      end
+      raise "Couldn't find repository element with #{what.inspect} by #{how.inspect}" if element.nil?
+      return element
+    end
+
+    def method_missing(meth_name, what, &block)
+      case meth_name.to_s
+      when /^get_by_(.*)/
+        element = find(what, $1.to_sym)
+      when "get"
+        element = find(what)
+      else
+        super
+      end
+      return element.to_form_object(@browser, self)
+    end
+    
+    def inspect
+      @elements.inspect
+    end
+
+    private
+
+    def fill_elements(options)
+      eval("ObjectRepository::Reader::" + @type.upcase).read(@file, options) { |rep_id, type, hows, whats, description|
+        unless @elements.find { |el| el.id == rep_id }
+          @elements << RepositoryElement.new(rep_id, type, hows, whats, description)
+        else
+          raise "Duplicating of id: #{rep_id.inspect}"
+        end
+      }
+    rescue NameError => e
+      raise "Unknown type #{@type.inspect} of repository"
+    end
+  end
+end

data/lib/watir-or.rb

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

data/spec/browser_stub.rb

@@ -0,0 +1,5 @@
+class BrowserStub
+  def method_missing(meth_name, *args, &block)
+    return "%s(%s)" % [meth_name, args.first.inspect.gsub(/(^\{|\}$)/, "")]
+  end
+end

data/spec/custom_elements_spec.rb

@@ -0,0 +1,17 @@
+require 'lib/watir-or'
+require 'spec/browser_stub'
+TEST_FILE = "spec/test.xls"
+
+class MyCustomElement < ObjectRepository::CustomElement
+end
+
+describe "CustomElement" do
+  before(:all) do
+    @browser_stub = BrowserStub.new
+    @repository = ObjectRepository::Repository.new(TEST_FILE, @browser_stub)
+  end
+
+  it "should return MyCustomElement object" do
+    @repository.get("custom element").should be_a(MyCustomElement)
+  end
+end

data/spec/find_elements_spec.rb

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

data/spec/read_xls_spec.rb

@@ -0,0 +1,54 @@
+require 'lib/watir-or.rb'
+
+describe "Read xls-repository" do
+  context "Read first worksheet" do
+    before(:all) do
+      @repository = ObjectRepository::Repository.new("spec/test.xls", nil)
+    end
+
+    it "element with one attribute was readed" do
+      one = ObjectRepository::RepositoryElement.new("one attribute", "text_field", [:name],
+        ["test"], "Element with one attribute")
+      @repository.find("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.find("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.find("last element with many attributes").should == last_many
+    end
+  end
+
+  context "Read special worksheet" do
+    before(:all) do
+      @repository = ObjectRepository::Repository.new("spec/test.xls", nil, :tab => "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.find("first element").should == first
+    end
+  end
+
+  context "Read all worksheets" do
+    before(:all) do
+      @repository = ObjectRepository::Repository.new("spec/test.xls", nil, :tab => :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")
+      on_special_worksheet = ObjectRepository::RepositoryElement.new("first element", "text_field",
+        [:name], ["awesome"], "First element on special worksheet")
+      @repository.find("one attribute").should == on_first_worksheet
+      @repository.find("first element").should == on_special_worksheet
+    end
+  end
+end

data/spec/read_xml_spec.rb

@@ -0,0 +1,25 @@
+require 'lib/watir-or.rb'
+
+describe "Read xml-repository" do
+  before(:all) do
+    @repository = ObjectRepository::Repository.new("spec/test.xml", nil)
+  end
+
+  it "element with one attribute was readed" do
+    one = ObjectRepository::RepositoryElement.new("one attribute", "text_field", [:name],
+      ["test"], "Element with one attribute")
+    @repository.find("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.find("many attributes").should == many
+  end
+
+  it "child element was readed" do
+    child = ObjectRepository::RepositoryElement.new("with parent", "div", [:index, :parent],
+      [3, "parent element"], "Element with parent")
+    @repository.find("with parent").should == child
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--backtrace

data/spec/test.xml

@@ -0,0 +1,35 @@
+<?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>
+    <object type="select_list" id="many attributes">
+        <how>
+            <text>test text</text>
+            <index>1</index>
+        </how>
+        <description>Element with many attributes</description>
+    </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>value of attr1</attr1>
+            <attr2>value of attr2</attr2>
+        </how>
+        <description>Custom Element</description>
+    </object>
+</repository>

data/spec/watir_builder_spec.rb

@@ -0,0 +1,27 @@
+require 'lib/watir-or.rb'
+require 'spec/browser_stub'
+
+describe "WatirConverter" 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.elements.find {|el| el.id == "many attributes"}
+    built = ObjectRepository::ElementConverter::Watir.build_element(element, @repository)
+    built.should == 'select_list(:index=>1, :text=>"test text")'
+  end
+
+  it "build watir object which has one parent" do
+    element = @repository.elements.find {|el| el.id == "with parent"}
+    built = ObjectRepository::ElementConverter::Watir.build_element(element, @repository)
+    built.should == 'div(:index,1).div(:index,3)'
+  end
+
+  it "2 level hierarchy" do
+    element = @repository.elements.find {|el| el.id == "2 level hierarchy"}
+    built = ObjectRepository::ElementConverter::Watir.build_element(element, @repository)
+    built.should == 'div(:index,1).div(:index,3).div(:index,5)'
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification 
+name: watir-or
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Ivan Kabluchkov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-30 00:00:00 +04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: spreadsheet
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        - 3
+        - 1
+        version: 0.6.3.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 4
+        - 0
+        version: 1.4.0
+  type: :runtime
+  version_requirements: *id002
+description: Library for working with object repository for Watir
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- README
+- Rakefile
+- lib/watir-or.rb
+- lib/watir-or/repository.rb
+- lib/watir-or/readers/xml.rb
+- lib/watir-or/readers/xls.rb
+- lib/watir-or/element.rb
+- lib/watir-or/converters/element_converter.rb
+- spec/watir_builder_spec.rb
+- spec/browser_stub.rb
+- spec/read_xls_spec.rb
+- spec/test.xml
+- spec/test.xls
+- spec/custom_elements_spec.rb
+- spec/spec.opts
+- spec/find_elements_spec.rb
+- spec/read_xml_spec.rb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Object Repository for Watir
+test_files: 
+- spec/watir_builder_spec.rb
+- spec/read_xls_spec.rb
+- spec/custom_elements_spec.rb
+- spec/find_elements_spec.rb
+- spec/read_xml_spec.rb