capybara-wheel 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fd80ae9d800e4bff8293c3c6a913e0817915ee8e
+  data.tar.gz: 83f9bafd3a783f3c5503704e7b0f16988c4073db
+SHA512:
+  metadata.gz: 65aed3f76018833406c291d04acea02753f5541d672c0de57311eb1c6f1a406aa4caba3957dc2e463a70c93279f52df612fb8296e741ad77f3ff531673beba6e
+  data.tar.gz: a793890e6f6ae8f8ffbcb361c7bd68f5acf502cd1ba9b3c098601bc18558fa98001a04db98bb96f41d9f6b493c8f4e236cc0d2093e3fb7659b6a53a0550e6f4a

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Gabriel Rotbart
+
+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,159 @@
+# Capybara::Wheel
+> Keeping the rodent on track
+
+Capybara wheel is a page model framework which natively and (hopefully) easily enforces stability coventions:
+
+- No memoization. Every action or query relating to the page should make a new find callback to the actual page.
+ - Enforces native Capybara wait time when interacting with the page if the element is not there (yet) or changed.
+
+- No access to capybara directly from the specs.
+  - Enforces single point of reference to selectors / elements.
+  - Also helps reducing memoizations.
+
+- Subelements structure to scope finds to a specific section of the page.
+  - Reduces ambiguity.
+
+*A special thank you to @woollyams for the initial concept*
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'capybara-wheel'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capybara-wheel
+
+## Usage
+
+In spec_helper.rb:
+
+    $ require 'capybara/wheel'
+
+**Important: Capybara Wheel overrides Capybara native `feature` method to inject new behavior. This means it should be required instead or Capybara**
+
+## Modeling
+
+### Page Model
+
+
+To model a new page:
+
+    class NewPage < Capybara::Wheel::Page
+
+A page needs to implament two methods:
+
+    def path
+      # implament to support visiting the page directly
+      # Rails apps can include Rails.application.routes.url_helpers to access the url helpers
+      # Other applications should implament a relative url
+    end
+
+  and
+
+    def on_page?
+      # Capybara Wheel calls this method before excuting the page block (see Specs section below below)
+      # Recommended: Use Wheel native Page method has_title?('Title')
+      # e.g. has_title?('Login')
+
+      # Or: Use Capybara.find(any selector you expect would be on a loaded page)
+      # e.g. Capybara.find('h1', text: 'Login Page')
+    end
+
+> Example:
+>
+>     class SuperVillanConsole << Capybara::Wheel::Page
+>
+>       def path
+>         super_villan_console_path
+>       end
+>
+>       def on_page?
+>         has_title?('Destroy all humans')
+>       end
+>     end
+
+***
+
+### Element and Subelement model
+
+#### Element
+
+Once inside a Page model, it has access to the `element` method.
+
+    element 'ElementName', 'selector' *optional block*
+
+    # Wheel recommends using a name that follows the class constant name convention (i.e CamelCase)
+    # as an object will be created and assigned this name (see below)
+
+The `element` method does several important things:
+
+1. It defines a Page method element_name which allows access and initializes...
+2. an Element model
+
+Out of the box, Element accepts all the old familar Capybara Element actions / queries (e.g. click, set, text, visible?).Once an action or query is sent to a Wheel element it then finds the native Capybara element and passes it on. This ensures that each method call is executed on the newset version of the element.
+
+Passing a block to element gives access to the Element object for the purpose of implamenting SubElements (see below) or rolling your own methods:
+
+**The `capybara_element` method is the direct accessor to the native Capybara element callback.**
+
+> Example
+>
+>     element 'ButtonOfDoom', '#doom-button' do
+>
+>        def armed?
+>          capybara_element.text == 'Armed'
+>        end
+>
+>      end
+>
+>     element 'MissleTracker', '.missle-tracker'
+>
+>
+>     #=> SuperVillanConsole.new.button_of_doom.armed?
+>
+>     #=> SuperVillanConsole.new.missle_tracker.visible?
+>
+
+
+#### Subelement
+
+An element block also accepts the `subelement` method.
+
+    subelement 'SubElementName', 'selector' *optional block*
+
+A subelement behaves exactly like element with one difference, the find is scoped to the containing (or parent) element which reduces ambiguity.
+
+> Example
+>
+>     element 'ButtonOfDoom', '#doom-button' do
+>
+>        subelement 'ArmingKey', '#key' do
+>
+>          def turn
+>            capybara_element.click
+>          end
+>
+>        end
+>     end
+>
+>     #=> SuperVillanConsole.new.button_of_doom.turn
+
+***
+***
+***
+
+
+
+## Contributing
+
+1. Fork it
+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 @@
+require "bundler/gem_tasks"

data/capybara-wheel.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capybara/wheel/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "capybara-wheel"
+  spec.version       = Capybara::Wheel::VERSION
+  spec.authors       = ["@gabrielrotbart"]
+  spec.email         = ["gabe@hooroo.com"]
+  spec.description   = %q{Keeping the rodent on track}
+  spec.summary       = %q{Creating (yet another) page model gem based around making capybara tests more stable with no need for waits}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "selenium-webdriver", "~> 2.0"
+  spec.add_development_dependency "sinatra", "~> 1.0"
+  spec.add_development_dependency "pry"
+
+  spec.add_dependency "capybara", "~> 2.1"
+  spec.add_dependency "rspec"
+end

data/lib/capybara/wheel.rb

@@ -0,0 +1,34 @@
+Dir.glob(File.join(File.dirname(__FILE__), 'wheel', '*.rb')).each {|file| require file}
+require "capybara"
+require 'capybara/dsl'
+require 'rspec'
+
+module Capybara
+  module Wheel
+    # main mixin to access wheel
+
+    def self.included(base)
+      base.instance_eval do
+        alias :background :before
+        alias :scenario :it
+        alias :given :let
+        alias :given! :let!
+      end
+    end
+
+    module FeatureOverride
+      def feature(*args, &block)
+        options = {
+          type: :wheel_feature,
+          caller: caller
+        }
+        options.merge!(args.pop) if args.last.is_a?(Hash)
+        describe(*args, options, &block)
+      end
+    end
+
+  end
+end
+
+extend Capybara::Wheel::FeatureOverride
+RSpec.configuration.include Capybara::Wheel, wheel_feature: true

data/lib/capybara/wheel/element.rb

@@ -0,0 +1,75 @@
+require 'capybara/wheel/includes'
+require 'forwardable'
+
+module Capybara
+  module Wheel
+    class Element
+
+        extend Forwardable
+        include Capybara::Wheel::Includes
+        extend Capybara::Wheel::Includes::ClassIncludes
+
+        def initialize(selector = nil)
+          @selector = selector if selector
+        end
+
+        def_delegators  :capybara_element,
+                        :click,
+                        :has_content?,
+                        :checked?,
+                        :text,
+                        :visible?,
+                        :present?,
+                        :selected?,
+                        :disabled?,
+                        :tag_name,
+                        :value,
+                        :set,
+                        :select_option,
+                        :unselect_option,
+                        :hover,
+                        :[]
+
+
+
+        def present?
+          capybara_element.visible?
+        rescue Capybara::ElementNotFound => e
+          puts "#{e} on #{Time.now.strftime("%H:%I:%S:%L")}"
+          false
+        end
+
+        def visible?
+          capybara_element.visible?
+        rescue Capybara::ElementNotFound => e
+          puts "#{e} on #{Time.now.strftime("%H:%I:%S:%L")}"
+          false
+        end
+
+        def self.subelement(name, selector, block = nil)
+          subelement_factory = lambda do |parent_element|
+            Capybara::Wheel::ElementFactory.create_subelement(selector, parent_element, block)
+          end
+
+          define_method(underscore(name).to_sym) { subelement_factory.call(self) }
+          self
+        end
+
+        def subelement(name, selector, &block)
+          self.class.subelement(name, selector, block)
+        end
+
+        def selector
+          @selector
+        end
+
+        protected
+
+        # Finds a capybara element representing this thing
+        def capybara_element
+          capybara.find(selector)
+        end
+
+    end
+  end
+end

data/lib/capybara/wheel/element_factory.rb

@@ -0,0 +1,31 @@
+require 'capybara/wheel'
+
+module Capybara
+  module Wheel
+    class ElementFactory
+
+      def self.create_element_klass(selector, block = nil)
+        subclass = Class.new(Capybara::Wheel::Element)
+
+        _selector = selector
+
+        subclass.class_exec do
+          define_method(:selector) { @selector = _selector}
+        end
+
+        subclass.class_eval(&block) if block
+
+        subclass
+      end
+
+      #TODO: Pass object not an instance
+      def self.create_subelement(selector, parent_element, block = nil)
+        subelement = Capybara::Wheel::SubElement.new(selector, parent_element)
+        subelement.instance_eval(&block) if block
+
+        subelement
+      end
+
+    end
+  end
+end

data/lib/capybara/wheel/includes.rb

@@ -0,0 +1,32 @@
+require 'capybara/wheel'
+require 'capybara'
+require 'capybara/dsl'
+require 'rspec'
+
+module Capybara
+  module Wheel
+    module Includes
+
+      include Capybara::DSL
+
+      def capybara
+        Capybara.current_session
+      end
+
+      module ClassIncludes
+        def underscore(string)
+          string.gsub(/::/, '/').
+                  gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+                  gsub(/([a-z\d])([A-Z])/,'\1_\2').
+                  tr("-", "_").
+                  downcase
+        end
+
+        def make_const(string)
+
+        end
+      end
+
+    end
+  end
+end

data/lib/capybara/wheel/page.rb

@@ -0,0 +1,60 @@
+require 'capybara/wheel/includes'
+
+module Capybara
+  module Wheel
+    class Page
+
+      include Capybara::Wheel::Includes
+      extend Capybara::Wheel::Includes::ClassIncludes
+
+      # actively visits page and executes block in context
+      def visit(&block)
+        capybara.visit(path)
+        if block_given?
+          on(&block)
+        else
+          on_page?
+        end
+        return self
+      end
+
+      # execute a block in the context of this page
+      def on
+        unless on_page?
+          raise "We don't appear to be on #{description}"
+        end
+        yield self if block_given?
+        self
+      end
+
+      # Returns the path (relative URI) of this page
+      def path
+        raise NotImplementedError, "implement to support page.visit"
+      end
+
+      # Return true if the browser is on this page
+      def on_page?
+        raise NotImplementedError, "implement me, e.g. using #has_title?"
+      end
+
+      # callback commonly used for on_page?
+      def has_title?(expected_title)
+        capybara.has_css?("head title", :text => expected_title)
+      end
+
+      def self.element(name, selector, &block)
+        begin
+          element_klass = const_set("#{name}", Capybara::Wheel::ElementFactory.create_element_klass(selector, block))
+        rescue NameError
+          puts "We recommend using capitalized element and subelement names"
+          name = name.capitalize!
+          retry
+        end
+
+        define_method(underscore(name).to_sym) { element_klass.new(selector) }
+        self
+      end
+
+    end
+  end
+end

data/lib/capybara/wheel/subelement.rb

@@ -0,0 +1,24 @@
+require 'capybara/wheel/includes'
+
+module Capybara
+  module Wheel
+    class SubElement < Capybara::Wheel::Element
+      attr_reader :parent
+
+      def initialize(selector, parent)
+        @parent   = parent
+        @selector =  selector
+      end
+
+      private
+      def capybara_element
+        parent_element.find(selector)
+      end
+
+      def parent_element
+        parent.send(:capybara_element)
+      end
+
+    end
+  end
+end

data/lib/capybara/wheel/version.rb

@@ -0,0 +1,5 @@
+module Capybara
+  module Wheel
+    VERSION = "0.0.3"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rspec'
+require 'pry'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+end

data/spec/wheel_spec.rb

@@ -0,0 +1,108 @@
+require 'spec_helper'
+require 'capybara/wheel'
+
+RSpec.configure do |config|
+  config.before(:each, :some_hook) do
+    @hook_passed_on = true
+  end
+end
+
+feature 'runs as a wheel feature', :some_hook do
+
+  it 'should pass' do
+  end
+
+  it 'should be set as a wheel feature' do
+    example.metadata[:type].should == :wheel_feature
+  end
+
+  it 'should pass the right hook' do
+    @hook_passed_on.should be_true
+  end
+end
+
+feature 'Page' do
+  let(:page) { Capybara::Wheel::Page }
+
+  it 'has access to capybara' do
+    page.new.methods.include?(:capybara).should be_true
+  end
+
+  context 'can create an element instance' do
+    it 'and create a method for it' do
+      page.element('RadElement', '#rad-selector').new.should respond_to(:rad_element)
+    end
+  end
+
+end
+
+feature 'Element' do
+  let(:element) { Capybara::Wheel::Element }
+
+  it 'has access to capybara' do
+    element.new('#some-selector').methods.include?(:capybara).should be_true
+  end
+
+  context 'can create a subelement instance' do
+    let(:subelement_name)     { 'RadSubElement' }
+    let(:subelement_selector) { '#rad-sub-selector' }
+    let(:element_instance)    { element.new.subelement(subelement_name, subelement_selector).new('#rad-selector') }
+
+    it 'and create a method for it' do
+      element_instance.should respond_to(:rad_sub_element)
+    end
+
+    it 'create a subelement with parent element context' do
+      element_instance.send(:rad_sub_element).parent.should == element_instance
+    end
+  end
+
+end
+
+feature 'SubElement' do
+  let(:parent_selector) { '#parent-selector'}
+  let(:sub_selector)    { '#sub-selector'}
+  let!(:parent_element) { Capybara::Wheel::Element.new(parent_selector) }
+  let!(:subelement)     { class ASubElement < Capybara::Wheel::SubElement
+                              def my_element
+                                capybara_element
+                              end
+                          end }
+
+  before :each do
+    parent_element.instance_eval do
+      def a_sub_element
+        ASubElement.new('#sub-selector', self)
+      end
+    end
+  end
+
+  it 'calls parent element capybara_element' do
+    pending
+  end
+
+end
+
+feature 'ElementFactory' do
+  let(:subject)               { Capybara::Wheel::ElementFactory }
+  let(:selector)              { '#rad-selector'}
+  let(:created_element_klass) { subject.create_element_klass(selector) }
+
+
+  it 'creates an element' do
+    created_element_klass.superclass.should == Capybara::Wheel::Element
+  end
+
+  it 'allows access to the selector' do
+    created_element_klass.new.selector.should == selector
+  end
+
+  it 'generated instance evalutes block' do
+    test_block = Proc.new do
+      def evaled_method
+      end
+    end
+
+    subject.create_element_klass(selector, test_block).new.should respond_to(:evaled_method)
+  end
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: capybara-wheel
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- '@gabrielrotbart'
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 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: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Keeping the rodent on track
+email:
+- gabe@hooroo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capybara-wheel.gemspec
+- lib/capybara/wheel.rb
+- lib/capybara/wheel/element.rb
+- lib/capybara/wheel/element_factory.rb
+- lib/capybara/wheel/includes.rb
+- lib/capybara/wheel/page.rb
+- lib/capybara/wheel/subelement.rb
+- lib/capybara/wheel/version.rb
+- spec/spec_helper.rb
+- spec/wheel_spec.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.0.3
+signing_key: 
+specification_version: 4
+summary: Creating (yet another) page model gem based around making capybara tests
+  more stable with no need for waits
+test_files:
+- spec/spec_helper.rb
+- spec/wheel_spec.rb