k3_testing 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7ce15918881263ce04d979e3770fd24c4ea47410
+  data.tar.gz: 932ec59f91b770a06d8101dae8270f09d502bc3a
+SHA512:
+  metadata.gz: 5ecb58369e34bd076fa243321933bd8b72537b57a84b6cc0bfaee3e48ec52666d9c79fc6c19b12386f31fed02ff896cd28b48be50f9875dabe0b784cb543897b
+  data.tar.gz: 444387064027aa65916a900759872172c187102ea0d2cdb3cd7f68a8cbcb5a4d7583d78838d7baf9b8de2a7dc265d896719e8a6bc975cc8964741426cf98eae6

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 k3_testing.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 K3 Integrations, LLC
+
+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/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/Readme.md

@@ -0,0 +1,89 @@
+K3 Testing Helpers
+==================
+
+Provides Capybara selectors for finding the element in your document that represents a specific record, attribute, or role.
+
+Installation
+------------
+
+Add this line to your application's `Gemfile`:
+
+    gem 'k3_testing'
+
+And then execute:
+
+    $ bundle
+
+ActionView Helpers: Usage
+-------------------------
+
+The main helper this gem provides is `present_model`. This method allows you to represent an
+ActiveRecord object as HTML and will add appropriate data-role attributes as needed.
+
+The simplest way of calling, just represents the object and one of its
+attributes...
+
+    <%= present_model @user, :name %>
+
+Will render something like the following:
+
+     <div data-role="user.42.name">Joe Blow</div>
+
+You can also pass extra html attributes with your call by specifying
+`:html_options` as an extra parameter.  If you don't want a div element,
+you may specify `:as` as a parameter as well.  For example:
+
+    <%= present_model @user, :name, :as => :span, :html_options => {:id => 'current_user'} %>
+
+Will render something like the following:
+
+    <span data-role="user.42.name" id="current_user">Joe Blow</span>
+
+You may also leave out the attribute and specify a block having a single
+parameter.  That parameter may be used to render attribute elements.
+For example:
+
+    <%= present_model @user do |u| %>
+      <%= u.attr :name %> is
+      <%= u.attr :age %> years old.
+    <% end %>
+
+Will render something like:
+
+    <div data-role="user.42">
+      <span data-role="user.42.name">Joe Blow</span> is
+      <span data-role="user.42.age">55</span> years old
+    </div>
+
+Finally, the `attr` method can also take the options `:as` and
+`:html_options`, or even take a block.  For example:
+
+    <%= present_model @user, :as => :tr do |u| %>
+      <%= u.attr :name, :as => :td, :html_options => {:class => 'name'} %>
+      <%= u.attr :age, :as => :td do %>
+        <%= u.object.age %> years old
+      <% end %>
+    <% end %>
+
+Will render something like:
+
+    <tr data-role="user.42">
+      <td data-role="user.42.name" class="name">Joe Blow</td>
+      <td data-role="user.42.name">55 years old</td>
+    </tr>
+
+
+Capybara selectors:
+-------------------
+
+Add this line to your `features/support/env.rb` (assuming you're using cucumber):
+
+    require 'k3_testing/capybara/selectors'   
+
+Then you will be able to use the selectors like this:
+
+    @user = User.first
+    find @user
+    page.find('table#myTable').find(@user).text
+    page.find('table#myTable').has_selector?(@user)
+    within(@user) { page.should have_content('$100.000') }

data/k3_testing.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/k3_testing/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Tyler Rick"]
+  gem.email         = ["tyler@k3integrations.com"]
+  gem.description   = %q{Capybara selectors for finding the element in your document that represents a specific record, attribute, or role}
+  gem.summary       = gem.description
+  gem.homepage      = ""
+
+  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.name          = "k3_testing"
+  gem.require_paths = ["lib"]
+  gem.version       = K3Testing::Version
+end

data/lib/k3_testing/capybara/selectors.rb

@@ -0,0 +1,27 @@
+# Example usage:
+#   @user = User.first
+#   find @user
+#   page.find('table#myTable').find(@user).text
+#   page.find('table#myTable').has_selector?(@user)
+#   within(@user) { page.should have_content('$100.000') }
+Capybara.add_selector(:active_record_object) do
+  xpath { |obj| XPath.descendant[XPath.attr('data-role') == K3Testing::PresentModel.role_for(obj)] }
+  #failure_message { |node, selector| "no element found for obj #{obj}" }
+  match { |value| value.is_a?(ActiveRecord::Base) }
+end
+
+# Example usage:
+#   @user = User.first
+#   find [@user, :name]
+#   within(:content) { find [@user, :name] }
+Capybara.add_selector(:active_record_object_with_attribute) do
+  xpath { |params| XPath.descendant[XPath.attr('data-role') == K3Testing::PresentModel.role_for(*params)] }
+  #failure_message { |node, selector| "no element found for obj #{obj} and attribute #{attr_name}" }
+  match { |params| params.is_a?(Array) && params[0].is_a?(ActiveRecord::Base) }
+end
+
+# TODO: Use starts-with(string1,string2) XPath selector (apparable not available in xpath gem)
+Capybara.add_selector(:with_role) do
+  xpath { |value| XPath.descendant[XPath.attr('data-role').contains value] }
+  failure_message { |node, selector| "no element found with role '#{selector.locator}'" }
+end

data/lib/k3_testing/presenter.rb

@@ -0,0 +1,111 @@
+module K3Testing
+  # PresentModel adds a helper method to assist with creating HTML with
+  # data-role attributes identifying it.  This is especially useful for testing
+  # but can also help with Javascript as well.
+  module PresentModel
+    # This method allows you to represent an ActiveRecord object as HTML and
+    # will add appropriate data-role attributes as needed.
+    #
+    # ==== Examples
+    #
+    # The simplest way of calling, just represents the object and one of its
+    # attributes...
+    #
+    #   <%= present_model @user, :name %>
+    #
+    # Will render something like the following:
+    #
+    #   <div data-role="user.42.name">Joe Blow</div>
+    #
+    # You can also pass extra html attributes with your call by specifying
+    # +:html_options+ as an extra parameter.  If you don't want a div element,
+    # you may specify +:as+ as a parameter as well.  For example:
+    #
+    #   <%= present_model @user, :name, :as => :span, :html_options => {:id => 'current_user'} %>
+    #
+    # Will render something like the following:
+    #
+    #   <span data-role="user.42.name" id="current_user">Joe Blow</span>
+    #
+    # You may also leave out the attribute and specify a block having a single
+    # parameter.  That parameter may be used to render attribute elements.
+    # For example:
+    #
+    #   <%= present_model @user do |u| %>
+    #     <%= u.attr :name %> is
+    #     <%= u.attr :age %> years old.
+    #   <% end %>
+    #
+    # Will render something like:
+    #
+    #   <div data-role="user.42">
+    #     <span data-role="user.42.name">Joe Blow</span> is
+    #     <span data-role="user.42.age">55</span> years old
+    #   </div>
+    #
+    # Finally, the +attr+ method can also take the options +:as+ and
+    # +:html_options+, or even take a block.  For example:
+    #
+    #   <%= present_model @user, :as => :tr do |u| %>
+    #     <%= u.attr :name, :as => :td, :html_options => {:class => 'name'} %>
+    #     <%= u.attr :age, :as => :td do %>
+    #       <%= u.object.age %> years old
+    #     <% end %>
+    #   <% end %>
+    #
+    # Will render something like:
+    #
+    #   <tr data-role="user.42">
+    #     <td data-role="user.42.name" class="name">Joe Blow</td>
+    #     <td data-role="user.42.name">55 years old</td>
+    #   </tr>
+    #
+    def present_model(obj, *attr_and_options, &block)
+      options = attr_and_options.last.is_a?(Hash) ? attr_and_options.pop : {}
+      attr = attr_and_options.pop
+      tag = options[:as] || :div
+      presenter = Presenter.new(obj,self)
+      output = block.nil? ? obj.send(attr).to_s : capture(presenter, &block)
+      html_opts = (options[:html_options] || {}).merge(role_hash_for(obj, attr))
+      content_tag tag, output, html_opts
+    end
+
+    # Returns just the data-role by itself in a hash for cases where you don't need the full
+    # Presenter or can't use it.
+    #
+    # This can be used to give a data-role attribute to an element in HAML, for example:
+    #   %li{role_hash_for(record)}
+    #
+    def role_hash_for(obj, attr=nil)
+      {'data-role' => PresentModel.role_for(obj, attr)}
+    end
+
+    # Returns just the name of the role by itself as a string.
+    #
+    def self.role_for(obj, attr=nil)
+      klass = obj.is_a?(Class) ? obj : obj.class
+      klass = klass.name.underscore
+      id    = ".#{obj.id}" if obj.respond_to?(:id)
+      attr  = ".#{attr}" unless attr.blank?
+      "#{klass}#{id}#{attr}"
+    end
+  end
+
+  class Presenter
+    attr_reader :object
+
+    def initialize(obj, parent)
+      @object = obj
+      @parent = parent
+    end
+
+    def attr(name, options={}, &block)
+      tag = options[:as] || :span
+      output = block.nil? ? object.send(name).to_s : @parent.capture(&block)
+      html_opts = (options[:html_options] || {}).merge('data-role' => "#{object.class.name.underscore}.#{object.id}.#{name.to_s}")
+      @parent.content_tag tag, output, html_opts
+    end
+  end
+end
+
+ActionView::Base.send :include, K3Testing::PresentModel

data/lib/k3_testing/version.rb

@@ -0,0 +1,3 @@
+module K3Testing
+  Version = "0.0.1"
+end

data/lib/k3_testing.rb

@@ -0,0 +1,5 @@
+require "k3_testing/version"
+require "k3_testing/presenter"
+
+module K3Testing
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: k3_testing
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tyler Rick
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-11 00:00:00.000000000 Z
+dependencies: []
+description: Capybara selectors for finding the element in your document that represents
+  a specific record, attribute, or role
+email:
+- tyler@k3integrations.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- Rakefile
+- Readme.md
+- k3_testing.gemspec
+- lib/k3_testing.rb
+- lib/k3_testing/capybara/selectors.rb
+- lib/k3_testing/presenter.rb
+- lib/k3_testing/version.rb
+homepage: ''
+licenses: []
+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.0
+signing_key: 
+specification_version: 4
+summary: Capybara selectors for finding the element in your document that represents
+  a specific record, attribute, or role
+test_files: []