domkey 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4e084e3b9ec1fd8d799b054c5c7621ff614cbe25
+  data.tar.gz: cc50953f3c169a28d21346e076681fb7e3dcc099
+SHA512:
+  metadata.gz: 708a161af1039a64b5beed49e5b8b3ea354387624ceae4fa810f9c52993aa21fb41b493778f6bd816a75a751a55ba060d2b86c4d743ff75fbdd58e4dece13aa8
+  data.tar.gz: 49e6a0ff0391b95355d136dcc44d9fae71acf7413829ea52cf3e0008d16a11de06d002a714071558b0f31a22bfe487a1f11289523e928f3f600c06238c70d095

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in domkey.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 rubytester
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,37 @@
+# Domain Specifc PageObject for Selenium Watir-Webdriver
+
+PageObject that models business domain first and browser code second.
+
+Watir-Webdriver is the Bee's Knees! Now with Domain Specific PageObject Factory!
+
+Watir-Webdriver is the Bee's Knees! Now with Domain Specific PageObject Factory!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'domkey'
+
+or this line to use gem directly from github
+
+    gem 'domkey', git: "git://github.com/rubytester/domkey.git"
+
+And then execute:
+
+    $ bundle
+
+Or install it from rubygems.org as:
+
+    $ gem install domkey
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/domkey/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+# kill browsers dude
+task :pkill do
+  `pkill -f firefox`
+end

data/domkey.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'domkey/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'domkey'
+  spec.version     = Domkey::VERSION
+  spec.authors     = ["rubytester", "marekj"]
+  spec.email       = ["github@rubytester.com"]
+  spec.summary     = %q{Domain Specifc PageObject for Selenium Watir-Webdriver}
+  spec.description = %q{Domain Specifc PageObject for Selenium Watir-Webdriver. PageObject that models business domain first and browser code second}
+  spec.homepage    = ''
+  spec.license     = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '~> 2.0'
+
+  spec.add_dependency 'watir-webdriver', '~> 0.6.4'
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 2.14'
+  spec.add_development_dependency 'simplecov'
+
+end

data/lib/domkey.rb

@@ -0,0 +1,18 @@
+require 'domkey/version'
+require 'watir-webdriver'
+require 'domkey/browser_session'
+require 'domkey/view'
+require 'domkey/exception'
+
+module Domkey
+
+  # current browser for testing session
+  def self.browser
+    BrowserSession.instance.browser
+  end
+
+  # sets current browser for testing session
+  def self.browser=(b)
+    BrowserSession.instance.browser=b
+  end
+end

data/lib/domkey/browser_session.rb

@@ -0,0 +1,14 @@
+require 'singleton'
+
+module Domkey
+
+  class BrowserSession
+    include Singleton
+    attr_accessor :browser
+
+    def browser
+      return @browser if (@browser && @browser.exist?)
+      @browser = Watir::Browser.new
+    end
+  end
+end

data/lib/domkey/exception.rb

@@ -0,0 +1,6 @@
+module Domkey
+  module Exception
+    class Error < StandardError
+    end
+  end
+end

data/lib/domkey/version.rb

@@ -0,0 +1,3 @@
+module Domkey
+  VERSION = "0.1.0"
+end

data/lib/domkey/view.rb

@@ -0,0 +1,39 @@
+require 'domkey/view/page_object'
+require 'domkey/view/page_object_collection'
+module Domkey
+
+  module View
+
+    module ClassMethods
+
+      # PageObjectCollection factory
+      def doms(key, &watirproc)
+        send :define_method, key do
+          PageObjectCollection.new watirproc, Proc.new { browser }
+        end
+      end
+
+      # PageObject factory
+      def dom(key, &watirproc)
+        send :define_method, key do
+          PageObject.new watirproc, Proc.new { browser }
+        end
+      end
+    end
+
+    def self.included(klass)
+      klass.extend(ClassMethods)
+    end
+
+    attr_accessor :browser
+
+    def initialize browser=nil
+      @browser = browser
+    end
+
+    def browser
+      @browser ||= Domkey.browser
+    end
+
+  end
+end

data/lib/domkey/view/page_object.rb

@@ -0,0 +1,120 @@
+module Domkey
+
+  module View
+
+    class PageObject
+
+      attr_accessor :watirproc, :container
+
+      # PageObject represents an semantically essential area in a View
+      # It is an object that responds to set and value as the main way of sending data to it.
+      # it is composed of one or more watir elements.
+      # PageObject encapuslates the widgetry of DOM elements to provide semantic interfact to the user of the widgetry
+      #
+      # Compose PageObject with watirproc and container
+      #
+      # What is a container? it's a proc, a callable object that plays a role of a container for watirproc widgetry
+      # container can be one of:
+      # - browser (default)
+      # - a pageobject
+      #
+      # What is watirproc? it's a proc of DOM elements widgetry that can be found inside the container
+      # watirproc can be one of the following:
+      #   - definition of single watir element i.e. `-> { text_field(:id, 'foo')}`
+      #   - a pageobject i.e. previously instantiated definition
+      #   - hash where key defines subelement and value a definition or pageobject
+      #
+      # Usage:
+      # Clients would not usually instantate this class.
+      # A client class which acts as a View would use a :dom factory method to create PageObjects
+      # Example:
+      #
+      #        class MyView
+      #          include Domkey::View
+      #
+      #          dom(:headline) { text_field(id:, 'some_desc_text') }
+      #
+      #          def property
+      #            PropertyPanel.new browser.div(id: 'container')
+      #          end
+      #        end
+      #
+      #        class PropertyPanel
+      #          include Domkey::View
+      #          dom(:headline) { text_field(class: 'headline_for_house') }
+      #        end
+      #
+      #        view = MyView.new
+      #        view.headline.set 'HomeAway Rules!'
+      #        view.value #=> returns 'HomeAway Rules!'
+      #        view.property.headline.set 'Awesome Vactaion Home'
+      #        view.property.headline.value #=> returns 'Awesome Vaction Home'
+      #
+      def initialize watirproc, container=lambda { Domkey.browser }
+        @container = container
+        @watirproc = initialize_this watirproc
+      end
+
+      def set value
+        return instantiator.set(value) unless value.respond_to?(:each_pair)
+        value.each_pair { |k, v| watirproc.fetch(k).set(v) }
+      end
+
+      def value
+        return instantiator.value unless watirproc.respond_to?(:each_pair)
+        Hash[watirproc.map { |key, pageobject| [key, pageobject.value] }]
+      end
+
+      # access widgetry of watir elements composing this page object
+      def element(key=false)
+        return instantiator unless watirproc.respond_to?(:each_pair)
+        return watirproc.fetch(key).element if key
+        Hash[watirproc.map { |key, watirproc| [key, watirproc.element] }]
+      end
+
+      private
+
+      # recursive
+      def initialize_this watirproc
+        if watirproc.respond_to?(:each_pair) #hash
+          Hash[watirproc.map { |key, watirproc| [key, PageObject.new(watirproc, container)] }]
+        else
+          if watirproc.respond_to?(:call) #proc
+            begin
+              # peek inside suitcase that is proc. XXX ouch, ugly
+              peeked_inside = watirproc.call
+            rescue NoMethodError
+              return watirproc #suitecase exploded, proc returned
+            end
+            if peeked_inside.respond_to?(:each_pair) # hash
+              return initialize_this peeked_inside
+            elsif peeked_inside.respond_to?(:wd) # watir element
+              return lambda { peeked_inside }
+            elsif peeked_inside.respond_to?(:watirproc) #pageobject
+              return peeked_inside.watirproc
+            else
+              fail Exception::Error, "watirproc must be kind of hash, watirelement or pageobject but I got this: #{watirproc}"
+            end
+          elsif watirproc.respond_to?(:watirproc) #pageobject
+            return watirproc.watirproc
+          else
+            fail Exception::Error, "watirproc must be kind of hash, watirelement or pageobject but I got this: #{watirproc}"
+          end
+        end
+      end
+
+      # talk to the browser executor.
+      # returns runtime element in a specified container
+      # expects that element to respond to set and value
+      def instantiator
+        container_instantiator.instance_exec(&watirproc)
+      end
+
+      # talk to the browser
+      # returns runtime container element in a browser/driver
+      def container_instantiator
+        container.respond_to?(:call) ? container.call : container.send(:instantiator)
+      end
+    end
+  end
+end

data/lib/domkey/view/page_object_collection.rb

@@ -0,0 +1,78 @@
+module Domkey
+
+  module View
+
+    class PageObjectCollection
+      include Enumerable
+
+      attr_accessor :watirproc, :container
+
+      # PageObjectCollection see PageObject for detailes.
+      # Compose PageObjectCollection with watirproc and container
+      #
+      # What is a container? see PageObject container
+      #
+      # What is watirproc? see PageObject watirproc except the following:
+      # watirproc can be one of the following:
+      #   - definition of watir elements collection i.e. `-> { text_fields(:class, /^foo/)}`
+      #   - a pageobject i.e. previously instantiated definition watir elements collection
+      #   - hash where key defines subelement and value a definition or pageobject
+      # Usage:
+      # Clients would not usually instantate this class.
+      # A client class which acts as a View would use a :doms factory method to create PageObjectCollection
+      # Example:
+      #
+      def initialize watirproc, container=lambda { Domkey.browser }
+        @container = container
+        @watirproc = initialize_this watirproc
+      end
+
+      def element(key=false)
+        return instantiator unless watirproc.respond_to?(:each_pair)
+        return watirproc.fetch(key).element if key
+        Hash[watirproc.map { |key, watirproc| [key, watirproc.element] }]
+      end
+
+      def each(&blk)
+        if watirproc.respond_to?(:each_pair)
+          watirproc.map { |k, v| [k, PageObjectCollection.new(lambda { v }, @container)] }.each { |k, v| yield Hash[k, v] }
+        else
+          instantiator.each { |e| yield PageObject.new(lambda { e }, @container) }
+        end
+      end
+
+      def [] idx
+        to_a[idx]
+      end
+
+      alias_method :size, :count
+
+      private
+
+      # --
+      # recursive
+      def initialize_this watirproc
+        if watirproc.respond_to?(:each_pair) #hash
+          Hash[watirproc.map { |key, watirproc| [key, PageObjectCollection.new(watirproc, container)] }]
+        else
+          if watirproc.respond_to?(:call) #proc
+            watirproc
+          elsif watirproc.respond_to?(:watirproc)
+            watirproc.watirproc
+          else
+            fail Exception::Error, "watirproc must be kind of hash, watirelement or pageobject but I got this: #{watirproc}"
+          end
+        end
+      end
+
+      def instantiator
+        container_at_runtime.instance_exec(&watirproc)
+      end
+
+      def container_at_runtime
+        container.respond_to?(:call) ? container.call : container.send(:instantiator)
+      end
+
+    end
+  end
+end

data/spec/browser_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Domkey::BrowserSession do
+
+  context 'when no browsers present in the system' do
+
+    it 'browser gives us default browser' do
+      #ugly setup with singleton
+      Domkey::BrowserSession.instance.browser.close
+      Domkey::browser=nil
+
+      fakebrowser = double('browser')
+      fakebrowser.stub(:exist?).and_return(true)
+      Watir::Browser.should_receive(:new).once.and_return(fakebrowser)
+      b = Domkey.browser
+      b.should eq fakebrowser
+      b2 = Domkey.browser
+      b.should eql b2
+      Domkey::BrowserSession.instance.browser=nil
+    end
+
+  end
+end