capybara-harness 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.idea
+.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,5 @@
+source 'https://rubygems.org'
+
+gem 'rake'
+# Specify your gem's dependencies in capybara-harness.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Theo Mills
+
+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,48 @@
+# Capybara::Harness
+
+![alt text](http://upload.wikimedia.org/wikipedia/commons/b/bc/Capybara_harness.jpg "A dignified, harness-wearing capybara")
+
+Capybara::Harness implements a test harness strategy to easily query and manipulate DOM elements as self-contained
+objects in the context of feature or acceptance tests.
+
+By pulling redundant behavior out of scenarios and tests (such as filling out and submitting forms, or ensuring a
+comment element is visible on the page), the focus moves to the essential steps of the use cases and the intent of
+the feature becomes more legible.
+
+## Props
+
+I had been playing with the concept for a while in my acceptance tests, but this thoughtbot article really helped
+solidify the concept and highly influenced me:
+
+http://robots.thoughtbot.com/post/35776432958/better-support-with-test-harnesses
+
+## Status
+
+This library is still very much in the baking phase, although I am successfully using it in 2 production projects. I'll
+be adding specs in the coming weeks.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'capybara-harness'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capybara-harness
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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-harness.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capybara/harness/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "capybara-harness"
+  gem.version       = Capybara::Harness::VERSION
+  gem.authors       = ["Theo Mills"]
+  gem.email         = ["twmills@twmills.com"]
+  gem.description   = "A test harness strategy to easily query and manipulate DOM elements as self-contained objects in the context of feature or acceptance tests."
+  gem.summary       = "A test harness strategy to easily query and manipulate DOM elements as self-contained objects in the context of feature or acceptance tests."
+  gem.homepage      = "https://github.com/twmills/capybara-harness"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency('capybara', '>= 2.0')
+  gem.add_runtime_dependency(%q<activesupport>, [">= 3.0"])
+end

data/lib/capybara-harness.rb

@@ -0,0 +1,7 @@
+require "capybara-harness/version"
+
+module Capybara
+  module Harness
+    # Your code goes here...
+  end
+end

data/lib/capybara/harness/dom/attribute.rb

@@ -0,0 +1,25 @@
+module Capybara::Harness::Dom
+  class Attribute
+    include Capybara::DSL
+
+    attr_accessor :name, :contents
+
+    def initialize(name, options = {})
+      self.name = name
+      self.contents = options.delete(:contents)
+    end
+
+    def visible?(values)
+
+    end
+
+    def extract_value(values)
+      values = HashWithIndifferentAccess.new(values)
+      if contents
+        contents.call(values)
+      else
+        values[name].to_s
+      end
+    end
+  end
+end

data/lib/capybara/harness/dom/configuration.rb

@@ -0,0 +1,23 @@
+module Capybara::Harness::Dom
+  class Configuration
+
+    attr_accessor :selector, :finder_attr_name, :attributes, :form
+
+    def initialize(klass)
+      self.selector = klass.name.split('::').last.gsub("OnPage", '').underscore
+      self.attributes = {}
+    end
+
+    def add_attribute(name, options = {})
+      self.finder_attr_name = name.to_sym if options.has_key?(:finder) && options[:finder] == true
+      self.attributes[name] = Capybara::Dom::Attribute.new(name, options)
+    end
+
+    def set_form(name = nil, block = nil)
+      form = Capybara::Dom::Form.new(name)
+      block.call(form) unless block.nil?
+      self.form = form
+    end
+
+  end
+end

data/lib/capybara/harness/dom/field.rb

@@ -0,0 +1,45 @@
+module Capybara::Harness::Dom
+  class Field
+    include Capybara::DSL
+
+    attr_accessor :name, :label, :data_type, :through
+
+    def initialize(options = {})
+      self.name = options.delete(:name)
+      self.label = options.fetch(:label, name.to_s.titleize)
+      self.data_type = options.fetch(:data_type, :string)
+      self.through = options.delete(:through)
+    end
+
+    def fill(attrs = {})
+      if has_attribute?(attrs)
+        value = extract_value(attrs)
+        case data_type
+          when :string then fill_in(label, :with => value)
+          when :select then select(value, :from => label)
+        end
+      end
+    end
+
+    def through
+      @through.to_sym if @through
+    end
+
+    def name
+      @name.to_sym
+    end
+
+    private
+
+    def has_attribute?(attrs)
+      return attrs[through].has_key?(name) if through && attrs.has_key?(through)
+      attrs.has_key?(name)
+    end
+
+    def extract_value(attrs)
+      attrs = attrs[through] if attrs.has_key?(through)
+      attrs[name.to_sym]
+    end
+
+  end
+end

data/lib/capybara/harness/dom/field_set.rb

@@ -0,0 +1,32 @@
+module Capybara::Harness::Dom
+  class FieldSet
+    attr_accessor :name, :fields
+
+    def initialize(name)
+      self.name = name
+      self.fields = []
+    end
+
+    def field(*args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+
+      args.each do |field_name|
+        fields << Capybara::Dom::Field.new(options.merge(:name => field_name))
+      end
+    end
+
+    def fill(attrs = {})
+      if name
+        within("##{name}") { fill_fields(attrs) }
+      else
+        fill_fields(attrs)
+      end
+    end
+
+    private
+
+    def fill_fields(attrs)
+      fields.each { |f| f.fill(attrs) }
+    end
+  end
+end

data/lib/capybara/harness/dom/form.rb

@@ -0,0 +1,29 @@
+module Capybara::Harness::Dom
+  class Form
+    attr_accessor :name, :elements
+
+    def initialize(name = nil)
+      self.name = name
+      self.elements = []
+    end
+
+    def field(*args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+
+      args.each do |field_name|
+        elements << Capybara::Dom::Field.new(options.merge(:name => field_name))
+      end
+    end
+
+    def fieldset(name = nil, &block)
+      fieldset = Capybara::Dom::FieldSet.new(name)
+      block.call(fieldset)
+      elements << fieldset
+    end
+
+    def fill(attrs = {})
+      elements.each { |e| e.fill(attrs) }
+    end
+
+  end
+end

data/lib/capybara/harness/dom/subject.rb

@@ -0,0 +1,93 @@
+module Capybara::Harness::Dom
+  class Subject
+    include Capybara::DSL
+
+    attr_accessor :selector, :attributes, :finder_attr_name, :values, :form
+
+    def initialize(configuration, values = nil)
+      self.selector = configuration.selector
+      self.finder_attr_name = configuration.finder_attr_name
+      self.attributes = configuration.attributes
+      self.form = configuration.form
+      self.reset!(values)
+    end
+
+    # Public: Returns the value of the finder attribute for this subject.
+    def finder_attr
+      values[finder_attr_name] || ''
+    end
+
+    # Public: Scans the DOM and finds the node that represents the subject.
+    def element(root = nil)
+      root = root || page
+      root.find(".#{selector} .#{finder_attr_name}", :text => finder_attr).find(:xpath, ".//ancestor::*[@class='#{selector}']")
+    end
+
+    # Public: Scans the DOM and finds the node that represents the subject's list element.
+    def list
+      find("##{selector.to_s.pluralize}")
+    end
+
+    # Public: Scans the DOM and finds the node that represents the subject's form element and fills it with the supplied
+    # values. It also resets the subjects current value hash has with the new values.
+    #
+    # new_values - The values to fill the form with.
+    #
+    # Returns nothing of interest.
+    def fill_form(new_values = {})
+      new_values = HashWithIndifferentAccess.new(new_values)
+      form.fill(new_values)
+      self.reset!(new_values)
+    end
+
+    # Public: Returns true if the subject's element is present on the page.
+    def on_the_page?
+      has_attrs?(element)
+    end
+
+    # Public: Returns true if the subject's element is in the page's subject list.
+    def in_the_list?
+      return false unless list.has_css?(".#{selector} .#{finder_attr_name}", :text => finder_attr)
+      has_attrs?(element(list))
+    end
+
+    # Public: Returns true if the subject's element is located first in its list.
+    def first_in_the_list?
+      node = list.first(".#{selector}")
+      return false if node.nil?
+      has_attrs?(node)
+    end
+
+    # Public: Returns true if the subject's element is located last in its list.
+    def last_in_the_list?
+      node = list.all(".#{selector}").last
+      return false if node.nil?
+      has_attrs?(node)
+    end
+
+    # Public: Finds and clicks the element's link that is assigned the data attribute for the supplied action. Common actions
+    # include :edit or :delete.
+    def click_action(action)
+      element.find("[data-#{selector}-action='#{action}']").click
+    end
+
+    private
+
+    def has_attrs?(node)
+      attributes.each do |attr_name, attr|
+        text = attr.extract_value(values)
+        return false unless node.has_css?(".#{attr_name}", :text => text)
+      end
+
+      true
+    end
+
+    def reset!(subject_values = {})
+      self.values = {}
+      attributes.each do |name, attribute|
+        values[name] = attribute.extract_value(subject_values)
+      end
+      self.values = HashWithIndifferentAccess.new(self.values.merge(subject_values))
+    end
+  end
+end

data/lib/capybara/harness/dom_harness.rb

@@ -0,0 +1,57 @@
+require 'active_support/core_ext/class'
+require 'spec/support/capybara/dom/configuration'
+require 'forwardable'
+
+class Capybara::Harness::DomHarness
+
+  extend Forwardable
+  include Capybara::DSL
+  include Rails.application.routes.url_helpers
+
+  attr_accessor :subject
+
+  def_delegators :subject,
+                 :selector,
+                 :element,
+                 :list,
+                 :on_the_page?,
+                 :in_the_list?,
+                 :last_in_the_list?,
+                 :first_in_the_list?,
+                 :fill_form,
+                 :click_action
+
+  def initialize(values = {})
+    self.subject = Capybara::Dom::Subject.new(self.class.configuration, values)
+    create_aliases!
+  end
+
+  def self.configuration
+    @configuration = Capybara::Dom::Configuration.new(self) unless @configuration
+    @configuration
+  end
+
+  def self.dom_selector(name)
+    self.configuration.selector = name
+  end
+
+  def self.define_form(name = nil, &block)
+    self.configuration.set_form(name, block)
+  end
+
+  def self.dom_attr(name, options = {})
+    self.configuration.add_attribute(name, options)
+  end
+
+  private
+
+  def create_aliases!
+    singleton = class << self;
+      self
+    end
+
+    singleton.send(:alias_method, selector, element)
+    singleton.send(:alias_method, "#{selector}_list", list)
+  end
+
+end

data/lib/capybara/harness/version.rb

@@ -0,0 +1,5 @@
+module Capybara
+  module Harness
+    VERSION = "0.0.1"
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: capybara-harness
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Theo Mills
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: &70275552304340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70275552304340
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70275552303820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70275552303820
+description: A test harness strategy to easily query and manipulate DOM elements as
+  self-contained objects in the context of feature or acceptance tests.
+email:
+- twmills@twmills.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capybara-harness.gemspec
+- lib/capybara-harness.rb
+- lib/capybara/harness/dom/attribute.rb
+- lib/capybara/harness/dom/configuration.rb
+- lib/capybara/harness/dom/field.rb
+- lib/capybara/harness/dom/field_set.rb
+- lib/capybara/harness/dom/form.rb
+- lib/capybara/harness/dom/subject.rb
+- lib/capybara/harness/dom_harness.rb
+- lib/capybara/harness/version.rb
+homepage: https://github.com/twmills/capybara-harness
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3234655397199029985
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3234655397199029985
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: A test harness strategy to easily query and manipulate DOM elements as self-contained
+  objects in the context of feature or acceptance tests.
+test_files: []