capybara_objects 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 760fe81c054babc77fca4124d22114c54351f2b8
+  data.tar.gz: 8a5dfcf3396fb746eadced9fec1140deb31a3bfa
+SHA512:
+  metadata.gz: 40b8e7d963047ba538f089be89ab1f80caf792247bb4a8a4aa74e056a61f7be5158b24b0aa436cea7b1995cfb146592880694d82908a7d669c0b2b32792eb83b
+  data.tar.gz: f30701daf9381c01760faf6daf2bee4d62e247f29cc70eda9b0a373f25b623cec27d60cebbe6f4ceebbbb7e42f5cbf042d853a562266a6f1e9d5dc8892aaad7f

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Gary Taylor
+
+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,41 @@
+# CapybaraObjects
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/capybara_objects`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capybara_objects'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capybara_objects
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/capybara_objects.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "capybara_objects"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/capybara_objects.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capybara_objects/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "capybara_objects"
+  spec.version       = CapybaraObjects::VERSION
+  spec.authors       = ["Gary Taylor"]
+  spec.email         = ["gary.taylor@hismessages.com"]
+
+  spec.summary       = "OO Style page objects for capybara"
+  spec.description   = "OO Style page objects for capybara"
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+
+  spec.add_runtime_dependency "activesupport", "~> 4.2"
+end

data/lib/capybara_objects.rb

@@ -0,0 +1,9 @@
+require "capybara_objects/version"
+require "capybara_objects/exceptions"
+require "capybara_objects/configure_capybara"
+require "capybara_objects/rspec"
+require "capybara_objects/component_object"
+require "capybara_objects/page_object"
+module CapybaraObjects
+  # Your code goes here...
+end

data/lib/capybara_objects/component_object.rb

@@ -0,0 +1,23 @@
+require "capybara_objects/registry_methods"
+require "capybara_objects/initialize_methods"
+require "capybara_objects/scoped_finders"
+require "capybara_objects/location_methods"
+require "capybara_objects/validation_methods"
+require "capybara_objects/convenience_methods"
+module CapybaraObjects
+  class ComponentObject
+    include RegistryMethods
+    include InitializeMethods
+    include LocationMethods
+    include ValidationMethods
+    include ConvenienceMethods
+    include ScopedFinders
+    class << self
+      def ctype(type)
+        registry.register_ctype type, self
+      end
+    end
+
+
+  end
+end

data/lib/capybara_objects/configure_capybara.rb

@@ -0,0 +1,23 @@
+# Allows the use of :ctype in a capybara finder spec
+# the argument can either be a symbol, string or an array
+# If a symbol or string, the component object is looked up by its ctype in the registry
+# If an array, these are treated as multiple arguments, the first one being as above,
+# and the remainder are passed on to the instance of the component object
+Capybara.add_selector(:ctype) do
+  xpath do |args|
+    local_args = args
+    local_args = [args] unless args.is_a? Array
+    ctype, *other_args = local_args
+    component = ::CapybaraObjects::RegistryInstance.instance.lookup_ctype(ctype).new(*other_args)
+    query = ::Capybara::Query.new(*component.locator)
+    selector = query.selector
+    @format = selector.format
+    if selector.format == :css
+      @css = selector.css
+      @xpath = nil
+    else
+      @xpath = selector.xpath
+    end
+    query.expression
+  end
+end

data/lib/capybara_objects/convenience_methods.rb

@@ -0,0 +1,22 @@
+require "active_support/concern"
+module CapybaraObjects
+  module ConvenienceMethods
+    extend ActiveSupport::Concern
+
+    delegate :find, :within, to: :page
+    # The capybara current session
+    # @return [Capybara::Session] The current session
+    def page
+      Capybara.current_session
+    end
+    # Hovers over the root node of this component
+    def hover
+      root_node.hover
+    end
+    # Clicks on the root node of this component
+    def click
+      root_node.click
+    end
+
+  end
+end

data/lib/capybara_objects/exceptions.rb

@@ -0,0 +1,2 @@
+require_relative "exceptions/type_not_registered"
+require_relative "exceptions/missing_url"

data/lib/capybara_objects/exceptions/missing_locator.rb

@@ -0,0 +1,9 @@
+module CapybaraObjects
+  module Exceptions
+    class MissingLocator < StandardError
+      def to_s
+        "CapybaraObjects::Exceptions::MissingLocator - Please ensure either a default_locator (class level) or a locator (instance level) has been declared"
+      end
+    end
+  end
+end

data/lib/capybara_objects/exceptions/missing_url.rb

@@ -0,0 +1,9 @@
+module CapybaraObjects
+  module Exceptions
+    class MissingUrl < StandardError
+      def to_s
+        "CapybaraObjects::Exceptions::MissingUrl - Please ensure either a default_url (class level) or a url (instance level) has been declared"
+      end
+    end
+  end
+end

data/lib/capybara_objects/exceptions/type_not_registered.rb

@@ -0,0 +1,15 @@
+module CapybaraObjects
+  module Exceptions
+    class TypeNotRegistered < StandardError
+      attr_accessor :type
+      def initialize(type)
+        self.type = type
+      end
+
+      def to_s
+        "Type not registered in CapybaraObjects::RegistryInstance (#{type})"
+      end
+
+    end
+  end
+end

data/lib/capybara_objects/initialize_methods.rb

@@ -0,0 +1,22 @@
+require "active_support/concern"
+module CapybaraObjects
+  module InitializeMethods
+    extend ActiveSupport::Concern
+    included do
+      private
+
+      attr_accessor :options
+
+    end
+
+    def initialize(options = {})
+      my_options = options.dup
+      my_options.keys.each do |key|
+        if respond_to?("#{key}=".to_sym)
+          send("#{key}=", my_options.delete(key))
+        end
+      end
+      self.options = my_options
+    end
+  end
+end

data/lib/capybara_objects/location_methods.rb

@@ -0,0 +1,25 @@
+require "active_support/concern"
+require "capybara_objects/registry_instance"
+module CapybaraObjects
+  module LocationMethods
+    extend ActiveSupport::Concern
+    included do |base|
+      class_attribute :default_locator
+      attr_accessor :locator, :scope
+    end
+
+    def initialize(attrs = {})
+      self.locator = default_locator
+      self.scope = []
+      super
+      locator.freeze
+    end
+
+    class_methods do
+      def locator(*args)
+        self.default_locator = args
+      end
+    end
+
+  end
+end

data/lib/capybara_objects/page_object.rb

@@ -0,0 +1,60 @@
+require "capybara_objects/registry_methods"
+require "capybara_objects/initialize_methods"
+require "capybara_objects/scoped_finders"
+require "capybara_objects/location_methods"
+require "capybara_objects/validation_methods"
+require "capybara_objects/convenience_methods"
+module CapybaraObjects
+  #
+  # A page object
+  #
+  class PageObject
+    include RegistryMethods
+    include InitializeMethods
+    include LocationMethods
+    include ValidationMethods
+    include ConvenienceMethods
+    include ScopedFinders
+    attr_accessor :url
+    class << self
+      # Registers a "ptype" alias for this class
+      # @param [String] type The alias or type to register this class with.
+      def ptype(type)
+        registry.register_ptype type, self
+      end
+
+      # Defines the default url. Can be overriden in the instance
+      # @param [String] url The default url
+      def url(url)
+        self.default_url = url
+      end
+    end
+
+    def initialize(options = {})
+      super
+      self.url ||= default_url
+    end
+
+    # Visits the pre configured URL to make this page available
+    # @raise ::CapybaraPageObjects::Exceptions::MissingUrl
+    # @return [::CapybaraObjects::PageObject] self - allows chaining of methods
+    def visit
+      raise ::CapybaraObjects::Exceptions::MissingUrl unless url.present?
+      page.visit url
+      validate!
+      self
+    end
+
+    # Attaches the page object to the current page
+    # @return [::CapybaraObjects::PageObject] self - allows chaining of methods
+    def attach(options = {})
+      validate!
+      self
+    end
+
+    private
+    cattr_accessor :default_url
+
+
+  end
+end

data/lib/capybara_objects/registry_instance.rb

@@ -0,0 +1,50 @@
+module CapybaraObjects
+  class RegistryInstance
+    include Singleton
+    def initialize
+      self.ctypes = HashWithIndifferentAccess.new
+      self.ptypes = HashWithIndifferentAccess.new
+    end
+
+    #
+    # Registers a component class so an alias can be used rather than worrying about
+    # the module path etc..
+    # @param [String] type The type of component to register
+    # @param [Class] klass The class to register
+    def register_ctype(type, klass)
+      ctypes[type] = klass
+    end
+
+    # @TODO Raise exceptions if ptype or ctype not found
+
+    #
+    # Registers a page object class so an alias can be used rather than worrying about
+    # the module path etc..
+    # @param [String] type The type of page object to register
+    # @param [Class] klass The class to register
+    # @raise ::CapybaraObjects::Exceptions::UnregisteredType
+    def register_ptype(type, klass)
+      ptypes[type] = klass
+    end
+
+    # Lookup a component object by its type
+    # @param [String] ctype The component type to lookup
+    # @return [Class] The registered class
+    # @raise ::CapybaraObjects::Exceptions::TypeNotRegistered
+    def lookup_ctype(ctype)
+      ctypes[ctype] or raise Exceptions::TypeNotRegistered.new(ctype)
+    end
+
+    # Lookup a page object by its type
+    # @param [String] ptype The page object type to lookup
+    # @return [Class] The registered class
+    # @raise ::CapybaraObjects::Exceptions::TypeNotRegistered
+    def lookup_ptype(ptype)
+      ptypes[ptype] or raise Exceptions::TypeNotRegistered.new(ptype)
+    end
+
+
+    private
+    attr_accessor :ctypes, :ptypes
+  end
+end

data/lib/capybara_objects/registry_methods.rb

@@ -0,0 +1,16 @@
+require "active_support/concern"
+require "capybara_objects/registry_instance"
+module CapybaraObjects
+  module RegistryMethods
+    extend ActiveSupport::Concern
+    included do
+      private
+      cattr_accessor :registry
+      self.registry = RegistryInstance.instance
+    end
+    class_methods do
+      private
+
+    end
+  end
+end

data/lib/capybara_objects/rspec.rb

@@ -0,0 +1,6 @@
+require "rspec/core"
+require "capybara_objects/rspec/helpers"
+::RSpec.configure do |config|
+  config.include CapybaraObjects::RSpec::Helpers::FeatureHelpers, :type => :feature
+
+end

data/lib/capybara_objects/rspec/helpers.rb

@@ -0,0 +1 @@
+require "capybara_objects/rspec/helpers/feature_helpers"

data/lib/capybara_objects/rspec/helpers/feature_helpers.rb

@@ -0,0 +1,27 @@
+require "capybara_objects/registry_instance"
+module CapybaraObjects
+  module RSpec
+    module Helpers
+      module FeatureHelpers
+
+        # Fetches a page object instance by its alias
+        # @param [String] ptype The page object type to lookup
+        # @param [*] args Any extra params are passed to the instance of the looked up class
+        # @return [::CapybaraObjects::PageObject] A new page object instance
+        def page_object_for(ptype, *args)
+          ::CapybaraObjects::RegistryInstance.instance.lookup_ptype(ptype).new(*args)
+        end
+
+        # Fetches a component object instance by its alias
+        # @param [String] ctype The component object type to lookup
+        # @param [*] args Any extra params are passed to the instance of the looked up class
+        # @return [::CapybaraObjects::ComponentObject] A new component object instance
+        def component_object_for(ctype, *args)
+          ::CapybaraObjects::RegistryInstance.instance.lookup_ctype(ctype, *args).tap do |instance|
+            instance.validate!
+          end
+        end
+      end
+    end
+  end
+end

data/lib/capybara_objects/scoped_finders.rb

@@ -0,0 +1,57 @@
+require "active_support/concern"
+module CapybaraObjects
+  module ScopedFinders
+    extend ActiveSupport::Concern
+
+    # Fetch a component from within this component
+    # @TODO Make this operate within the scope
+    # @TODO Pass the scope on to any found instances
+    # @param [String|Symbol] ctype The component alias to find
+    # @param [Any] args Any further arguments are passed on to the instance of the component
+    # @return [CapybaraObjects::ComponentObject] An instance inheriting from the component object
+    def get_component(ctype, *args)
+      registry.lookup_ctype(ctype).new(*args).tap do |comp|
+        comp.scope = full_scope
+        comp.validate!
+      end
+    end
+
+    def root_node
+      within_parent_scope do
+        find(*locator)
+      end
+    end
+
+    # Finds a node within the scope of this component
+    # @param [Any] args - All args get passed on to the normal capybara find method
+    # @return [Capybara::Node] The found node
+    def scoped_find(*args)
+      within_my_scope do
+        find(*args)
+      end
+    end
+
+
+
+    private
+
+    def full_scope
+      scope + [locator]
+    end
+
+    def within_my_scope(current_scope = full_scope, &blk)
+      next_scope = current_scope.shift
+      if next_scope
+        within(*next_scope) do
+          within_my_scope(current_scope, &blk)
+        end
+      else
+        yield
+      end
+    end
+
+    def within_parent_scope(&blk)
+      within_my_scope(scope.dup, &blk)
+    end
+  end
+end

data/lib/capybara_objects/validation_methods.rb

@@ -0,0 +1,18 @@
+require "active_support/concern"
+require "capybara_objects/registry_instance"
+require "capybara_objects/exceptions/missing_locator"
+module CapybaraObjects
+  module ValidationMethods
+    extend ActiveSupport::Concern
+    # Validates that the component exists
+    # this is simply done by searching for the root node.
+    # However, a sub class may implement its own stricter
+    # validation if required.
+    # @raise CapybaraObjects::Exceptions::MissingLocator If a locator hasn't been defined using default_locator or locator (instance)
+    def validate!
+      raise Exceptions::MissingLocator unless locator.present?
+      root_node.present?
+    end
+
+  end
+end

data/lib/capybara_objects/version.rb

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

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: capybara_objects
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gary Taylor
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: OO Style page objects for capybara
+email:
+- gary.taylor@hismessages.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- capybara_objects.gemspec
+- lib/capybara_objects.rb
+- lib/capybara_objects/component_object.rb
+- lib/capybara_objects/configure_capybara.rb
+- lib/capybara_objects/convenience_methods.rb
+- lib/capybara_objects/exceptions.rb
+- lib/capybara_objects/exceptions/missing_locator.rb
+- lib/capybara_objects/exceptions/missing_url.rb
+- lib/capybara_objects/exceptions/type_not_registered.rb
+- lib/capybara_objects/initialize_methods.rb
+- lib/capybara_objects/location_methods.rb
+- lib/capybara_objects/page_object.rb
+- lib/capybara_objects/registry_instance.rb
+- lib/capybara_objects/registry_methods.rb
+- lib/capybara_objects/rspec.rb
+- lib/capybara_objects/rspec/helpers.rb
+- lib/capybara_objects/rspec/helpers/feature_helpers.rb
+- lib/capybara_objects/scoped_finders.rb
+- lib/capybara_objects/validation_methods.rb
+- lib/capybara_objects/version.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: OO Style page objects for capybara
+test_files: []
+has_rdoc: