capybara-harness 0.0.8 → 0.0.9

data/.gitignore

@@ -2,6 +2,7 @@
 *.rbc
 .bundle
 .idea
+.rvmrc
 .config
 .yardoc
 Gemfile.lock

data/.rspec

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

data/capybara-harness.gemspec

@@ -17,6 +17,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
+  gem.add_development_dependency('rspec')
   gem.add_runtime_dependency('capybara', '>= 1.1')
   gem.add_runtime_dependency(%q<activesupport>, [">= 3.0"])
 end

data/lib/capybara/harness.rb

@@ -3,11 +3,10 @@ require "capybara/dsl"
 require "capybara/harness/version"
 require "capybara/harness/dom_harness"
 require "capybara/harness/dom/attribute"
-require "capybara/harness/dom/configuration"
 require "capybara/harness/dom/field"
-require "capybara/harness/dom/field_set"
-require "capybara/harness/dom/form"
+require "capybara/harness/dom/reader"
 require "capybara/harness/dom/subject"
+require "capybara/harness/dom/writer"
 
 
 module Capybara

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

@@ -2,19 +2,19 @@ module Capybara::Harness::Dom
   class Attribute
     include Capybara::DSL
 
-    attr_accessor :name, :contents
+    attr_accessor :name, :derived_value_block
 
     def initialize(name, options = {})
       self.name = name
-      self.contents = options.delete(:contents)
+      self.derived_value_block = options.delete(:derived_value_block)
     end
 
-    def extract_value(values = {})
-      values = HashWithIndifferentAccess.new(values)
-      if contents
-        contents.call(values)
+    def derive_value(values = {})
+      puts "Finding value for #{name}"
+      if derived_value_block
+        derived_value_block.call(values)
       else
-        values[name].to_s
+        values.fetch(name, "")
       end
     end
   end

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

@@ -0,0 +1,70 @@
+module Capybara::Harness::Dom
+  class Reader
+    include Capybara::DSL
+
+    attr_accessor :attributes, :finder_attr_name, :name
+
+    def initialize
+      self.attributes = {}
+    end
+
+    def attribute(name, options = {}, &block)
+      self.finder_attr_name = name.to_sym if options.delete(:finder)
+      options.merge!(:derived_value_block => block)
+      attributes[name] = Capybara::Harness::Dom::Attribute.new(name, options)
+    end
+
+    # Public: Scans the DOM and finds the node that represents the subject.
+    def find_element(values = {})
+      page.find(".#{name} .#{finder_attr_name}", :text => finder_attr.derive_value(values)).find(:xpath, ".//ancestor::*[@class='#{name}']")
+    end
+
+    # Public: Scans the DOM and finds the node that represents the subject's list element.
+    def find_list
+      find("##{selector.to_s.pluralize}")
+    end
+
+    def find_element_through_list(values = {})
+      find_list.find_element(values)
+    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
+
+    def has_attrs?(values = {})
+      node = find_element(values)
+      attributes.each do |attr_name, attr|
+        text = attr.derive_value(values)
+        return false unless node.has_css?(".#{attr_name}", :text => text)
+      end
+
+      true
+    end
+
+    private
+
+    # Private: Returns the value of the finder attribute for this subject.
+    def finder_attr
+      attributes[finder_attr_name]
+    end
+
+
+  end
+end

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

@@ -2,30 +2,12 @@ module Capybara::Harness::Dom
   class Subject
     include Capybara::DSL
 
-    attr_accessor :selector, :attributes, :finder_attr_name, :values, :form
+    attr_accessor :dom_reader, :dom_writer, :values
 
-    def initialize(configuration, values = {})
-      self.selector = configuration.selector
-      self.finder_attr_name = configuration.finder_attr_name
-      self.attributes = configuration.attributes
-      self.form = configuration.form
-      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}")
+    def initialize(dom_reader, dom_writer, values = {})
+      self.dom_reader = dom_reader
+      self.dom_writer = dom_writer
+      self.values = values
     end
 
     # Public: Scans the DOM and finds the node that represents the subject's form element and fills it with the supplied
@@ -35,59 +17,39 @@ module Capybara::Harness::Dom
     #
     # Returns nothing of interest.
     def fill_form(new_values = {})
-      new_values = HashWithIndifferentAccess.new(new_values)
-      form.fill(new_values)
+      dom_writer.fill(new_values)
       reset!(new_values)
     end
 
     # Public: Returns true if the subject's element is present on the page.
     def on_the_page?
-      has_attrs?(element)
+      dom_reader.has_attrs?(self.values)
     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))
+    def element
+      @element ||= dom_reader.find_element(self.values)
     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)
+    def list
+      @list ||= dom_reader.find_list
     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)
+    def in_the_list?
+      return false unless list.has_css?(".#{selector} .#{finder_attr_name}", :text => finder_attr)
+      has_attrs?(element(list))
     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
+      dom_reader.find_element.find("[data-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
+    def reset!(new_values = {})
+      self.values = new_values
+      @element = nil
+      @list = nil
     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/{field_set.rb → writer.rb}

@@ -1,9 +1,8 @@
 module Capybara::Harness::Dom
-  class FieldSet
+  class Writer
     attr_accessor :name, :fields
 
-    def initialize(name)
-      self.name = name
+    def initialize
       self.fields = []
     end
 
@@ -16,17 +15,8 @@ module Capybara::Harness::Dom
     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_harness.rb

@@ -20,36 +20,48 @@ class Capybara::Harness::DomHarness
                  :click_action
 
   def initialize(values = {})
-    self.subject = Capybara::Harness::Dom::Subject.new(self.class.configuration, values)
-    create_aliases!
+    self.subject = Capybara::Harness::Dom::Subject.new(self.class.dom_reader, self.class.dom_writer, values)
+    create_aliases!(self.class.dom_reader.name)
   end
 
-  def self.configuration
-    @configuration = Capybara::Harness::Dom::Configuration.new(self) unless @configuration
-    @configuration
-  end
-
-  def self.dom_selector(name)
-    self.configuration.selector = name
-  end
+  [:reader, :writer].each do |m|
+    method_name = "dom_#{m}"
+    instance_variable_name = "@#{method_name}"
+    class_name = "Capybara::Harness::Dom::#{m.capitalize}"
 
-  def self.define_form(name = nil, &block)
-    self.configuration.set_form(name, block)
-  end
+    define_singleton_method method_name do
+      unless instance_variable_get(instance_variable_name)
+        instance_variable_set(instance_variable_name, constantize(class_name).new)
+      end
+      instance_variable_get(instance_variable_name)
+    end
 
-  def self.dom_attr(name, options = {})
-    self.configuration.add_attribute(name, options)
+    define_singleton_method("define_#{m}") do |name = nil, &block|
+      send(method_name).name = name
+      block.call(send(method_name)) unless block.nil?
+    end
   end
 
   private
 
-  def create_aliases!
+  def self.constantize(camel_cased_word)
+    names = camel_cased_word.split('::')
+    names.shift if names.empty? || names.first.empty?
+
+    constant = Object
+    names.each do |name|
+      constant = constant.const_defined?(name) ? constant.const_get(name) : constant.const_missing(name)
+    end
+    constant
+  end
+
+  def create_aliases!(name)
     singleton = class << self;
       self
     end
 
-    singleton.send(:alias_method, selector.to_sym, :element)
-    singleton.send(:alias_method, "#{selector}_list".to_sym, :list)
+    singleton.send(:alias_method, name, :element)
+    singleton.send(:alias_method, "#{name}_list".to_sym, :list)
   end
 
 end

data/lib/capybara/harness/version.rb

@@ -1,5 +1,5 @@
 module Capybara
   module Harness
-    VERSION = "0.0.8"
+    VERSION = "0.0.9"
   end
 end

data/spec/dom/attribute_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Capybara::Harness::Dom::Attribute do
+
+  let(:values) { { first_name: 'John', last_name: 'Doe' } }
+
+  context 'when no derived value is provided' do
+    subject { Capybara::Harness::Dom::Attribute.new(:first_name) }
+
+    it "returns the value from the supplied array" do
+      subject.derive_value(values).should == 'John'
+    end
+
+    it "returns an empty string when there is no matching value" do
+      subject.derive_value({ color: 'orange'}).should == ''
+    end
+  end
+
+  context 'when an evaluation block is provided' do
+    subject { Capybara::Harness::Dom::Attribute.new(:name, derived_value_block: ->(attrs){ "#{attrs[:first_name]} #{attrs[:last_name]}"}) }
+
+    it "returns the value from the supplied array" do
+      subject.derive_value(values).should == 'John Doe'
+    end
+  end
+
+end

data/spec/dom/reader_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe Capybara::Harness::Dom::Reader do
+  subject { Capybara::Harness::Dom::Reader.new }
+
+  context 'when adding attributes' do
+    it "sets the attribute" do
+      subject.attribute :first_name
+      subject.attributes.values.first.name.should == :first_name
+    end
+
+    context 'and the finder option is set' do
+      before { subject.attribute :first_name, finder: true }
+      its(:finder_attr_name) { should == :first_name }
+    end
+
+    context 'and an evaluation block is supplied' do
+      before do
+        subject.attribute :first_name, finder: true do
+          "value"
+        end
+      end
+      it "sets the evaluation block on the attribute" do
+        subject.attributes.values.first.derived_value_block.call([]).should == "value"
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'capybara-harness'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capybara-harness
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
   prerelease: 
 platform: ruby
 authors:
@@ -9,27 +9,33 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-24 00:00:00.000000000 Z
+date: 2013-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: capybara
-  requirement: !ruby/object:Gem::Requirement
+  name: rspec
+  requirement: &70360036898060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  version_requirements: *70360036898060
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: &70360036913400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70360036913400
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70360036912660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -37,12 +43,7 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '3.0'
+  version_requirements: *70360036912660
 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:
@@ -52,6 +53,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -60,13 +62,15 @@ files:
 - lib/capybara-harness.rb
 - 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/reader.rb
 - lib/capybara/harness/dom/subject.rb
+- lib/capybara/harness/dom/writer.rb
 - lib/capybara/harness/dom_harness.rb
 - lib/capybara/harness/version.rb
+- spec/dom/attribute_spec.rb
+- spec/dom/reader_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/twmills/capybara-harness
 licenses: []
 post_install_message: 
@@ -79,17 +83,26 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -1039635989425236426
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -1039635989425236426
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+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: []
+test_files:
+- spec/dom/attribute_spec.rb
+- spec/dom/reader_spec.rb
+- spec/spec_helper.rb

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

@@ -1,23 +0,0 @@
-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::Harness::Dom::Attribute.new(name, options)
-    end
-
-    def set_form(name = nil, block = nil)
-      form = Capybara::Harness::Dom::Form.new(name)
-      block.call(form) unless block.nil?
-      self.form = form
-    end
-
-  end
-end

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

@@ -1,29 +0,0 @@
-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::Harness::Dom::Field.new(options.merge(:name => field_name))
-      end
-    end
-
-    def fieldset(name = nil, &block)
-      fieldset = Capybara::Harness::Dom::FieldSet.new(name)
-      block.call(fieldset)
-      elements << fieldset
-    end
-
-    def fill(attrs = {})
-      elements.each { |e| e.fill(attrs) }
-    end
-
-  end
-end