prismatic 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3b860f32694f2a039255b65d1501f23ede0ddc1e
+  data.tar.gz: 313576b87a882d84baa3e9afce81b9a9e82799cd
+SHA512:
+  metadata.gz: 868108bfccf0444c6533c20deeeb45af88fc0608f5eb7f5ce7e8072f7319c8d41efc4c773eafa585f51287666faa09f121b0ca0672de98e1efa08d70211cb187
+  data.tar.gz: 3bf56cee6ce21f8b8b7e5938b78e7fbd6f65c61b8cab9ce3234c2a06b9c977efd20d3ae841cb731f49f7ecd9712d6f3cd44b11a273ba0944ed26dfd30c49d432

data/.gitignore

@@ -0,0 +1,3 @@
+/Gemfile.lock
+/coverage/
+/pkg/

data/.rspec

@@ -0,0 +1 @@
+-r spec_helper

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Joe Yates
+
+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,72 @@
+# Prismatic
+
+Use a naming convention inside your HTML to describe the DOM elements you
+want to access during tests. Prismatic will set up your SitePrism::Pages
+with the intended Sections and Elements.
+
+## Motivation
+
+SitePrism is a wonderful tool for describing web pages in integration tests.
+Unfortunately, it requires the creation of classes which use CSS selectors
+(of XPath expressions) to indicate the elements of interest.
+
+Prismatic aims to allow you skip the use of SitePrism's Page Object Model
+by indicating in the web page itself which are the objects you want to access
+in your tests thanks to [data attributes](http://www.w3.org/html/wg/drafts/html/master/dom.html#embedding-custom-non-visible-data-with-the-data-*-attributes).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'prismatic'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install prismatic
+```
+
+## Usage
+
+Given a page containing this:
+
+```html
+...
+<form data-prism-section="search" method="get" action="search">
+  <input type="text" data-prism-element="query">
+  <input type="submit" data-prism-element="start">
+</form>
+...
+```
+
+## Configuration
+
+In your test setup, do this:
+
+```ruby
+Prismatic.configure do |conf|
+  conf.foo = :bar
+end
+```
+
+Configuration options:
+
+* prefix: (default: 'prism'). By default, prismatic uses data attributes called 
+  'data-prism-*'. Set prefix to another value to allow data atributes to be
+  named differently.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/prismatic/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+task default: :spec
+
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+end

data/lib/prismatic.rb

@@ -0,0 +1,10 @@
+require 'capybara'
+require 'site_prism'
+
+module Prismatic
+end
+
+require 'prismatic/element_container'
+require 'prismatic/page'
+require 'prismatic/section'
+require 'prismatic/version'

data/lib/prismatic/element_container.rb

@@ -0,0 +1,31 @@
+module Prismatic::ElementContainer
+  private
+
+  def create_elements
+    find_matches 'element'
+    find_matches 'elements'
+    find_matches 'section'
+    find_matches 'sections'
+  end
+
+  def find_matches(type)
+    attribute = attribute_for(type)
+
+    find_all("[#{attribute}]").each do |el|
+      name = el[attribute]
+      if is_section?(type)
+        self.class.send type.intern, name, Prismatic::Section, "[#{attribute}=\"#{name}\"]"
+      else
+        self.class.send type.intern, name, "[#{attribute}=\"#{name}\"]"
+      end
+    end
+  end
+
+  def is_section?(type)
+    type.start_with?('section')
+  end
+
+  def attribute_for(type)
+    "data-prism-#{type}"
+  end
+end

data/lib/prismatic/page.rb

@@ -0,0 +1,7 @@
+class Prismatic::Page < SitePrism::Page
+  include Prismatic::ElementContainer
+
+  def initialize
+    create_elements
+  end
+end

data/lib/prismatic/section.rb

@@ -0,0 +1,8 @@
+class Prismatic::Section < SitePrism::Section
+  include Prismatic::ElementContainer
+
+  def initialize(parent, root_element)
+    super
+    create_elements
+  end
+end

data/lib/prismatic/version.rb

@@ -0,0 +1,6 @@
+module Prismatic
+  MAJOR = 0
+  MINOR = 0
+  REVISION = 1
+  VERSION = [MAJOR, MINOR, REVISION].join('.')
+end

data/prismatic.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'prismatic/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'prismatic'
+  spec.version       = Prismatic::VERSION
+  spec.authors       = ['Joe Yates']
+  spec.email         = ['joe.g.yates@gmail.com']
+  spec.summary       = "Automate SitePrism's access to DOM elements"
+  spec.description   = <<-EOT.gsub(/^ +/, '').gsub(/\n/, ' ')
+    Thanks to a naming convention, Prismatic recognises the DOM elements in your
+    web pages that you intend to access during integration tests and automatically
+    creates the intended SitePrism sections and elements.
+  EOT
+  spec.homepage      = 'https://github.com/joeyates/prismatic'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(spec)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'site_prism', '~> 2.6'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rspec'
+spec_path = File.dirname(__FILE__)
+$LOAD_PATH << File.expand_path('../lib', spec_path)
+
+require 'prismatic'

data/spec/unit/prismatic/page_spec.rb

@@ -0,0 +1,136 @@
+describe Prismatic::Page do
+  def make_element(name, attribute)
+    el = double(Capybara::Node::Element)
+    allow(el).to receive(:[]).with(attribute).and_return(name)
+    el
+  end
+
+  def make_section(name, attribute)
+    el = double("Prismatic::Section, #{name}")
+    allow(el).to receive(:[]).with(attribute).and_return(name)
+    el
+  end
+
+  let(:page) { double(Capybara::Session) }
+  let(:page_element_array) { [] }
+  let(:page_elements_array) { [] }
+  let(:page_section_array) { [] }
+  let(:page_sections_array) { [] }
+  let(:singleton_element) { make_element('foo', 'data-prism-element') }
+  let(:collection_element) { make_element('bar', 'data-prism-elements') }
+
+  specify { expect(subject).to be_a(SitePrism::Page) }
+
+  before do
+    allow(Capybara).to receive(:current_session).and_return(page)
+    allow(page).to receive(:all).with('[data-prism-element]').and_return(page_element_array)
+    allow(page).to receive(:all).with('[data-prism-elements]').and_return(page_elements_array)
+    allow(page).to receive(:all).with('[data-prism-section]').and_return(page_section_array)
+    allow(page).to receive(:all).with('[data-prism-sections]').and_return(page_sections_array)
+  end
+
+  context "for 'data-prism-element' attributes" do
+    let(:page_element_array) { [singleton_element] }
+
+    it "creates a single element" do
+      expect(subject).to respond_to('foo')
+    end
+  end
+
+  context "for 'data-prism-elements' attributes" do
+    let(:page_elements_array) { [collection_element] }
+    let(:bar_elements_array) { page_elements_array }
+
+    before do
+      allow(page).to receive(:all).with('[data-prism-elements="bar"]').and_return(bar_elements_array)
+    end
+
+    it "creates an arrays of elements" do
+      expect(subject.bar).to be_a(Array)
+    end
+  end
+
+  context 'sections' do
+    context "for 'data-prism-section' attributes" do
+      let(:section_name) { 'singleton-section' }
+      let(:singleton_section) { make_section(section_name, 'data-prism-section') }
+      let(:page_section_array) { [singleton_section] }
+      let(:foo_element_array) { [] }
+      let(:bar_elements_array) { [] }
+      let(:nested_section_array) { [] }
+      let(:nested_sections_array) { [] }
+
+      before do
+        allow(page).to receive(:all).with("[data-prism-section=\"#{section_name}\"]").and_return([singleton_section])
+        allow(page).to receive(:find).with("[data-prism-section=\"#{section_name}\"]").and_return(singleton_section)
+        allow(singleton_section).to receive(:all).with('[data-prism-element]').and_return(foo_element_array)
+        allow(singleton_section).to receive(:all).with('[data-prism-elements]').and_return(bar_elements_array)
+        allow(singleton_section).to receive(:all).with('[data-prism-section]').and_return(nested_section_array)
+        allow(singleton_section).to receive(:all).with('[data-prism-sections]').and_return(nested_sections_array)
+      end
+
+      it "creates a single section" do
+        expect(subject).to respond_to(section_name)
+      end
+
+      context "with contained 'data-prism-element' attributes" do
+        let(:foo_element_array) { [singleton_element] }
+
+        before do
+          allow(singleton_section).to receive(:find).with('[data-prism-element="foo"]').and_return(singleton_element)
+          allow(singleton_section).to receive(:find).with('[data-prism-elements="foo"]').and_return([])
+        end
+
+        it 'creates an element' do
+          expect(subject.send(section_name)).to respond_to(:foo)
+        end
+      end
+
+      context "with contained 'data-prism-elements' attributes" do
+        let(:bar_elements_array) { [collection_element] }
+
+        before do
+          allow(singleton_section).to receive(:all).with('[data-prism-element="foo"]').and_return(foo_element_array)
+          allow(singleton_section).to receive(:all).with('[data-prism-elements="foo"]').and_return(bar_elements_array)
+          allow(singleton_section).to receive(:find).with('[data-prism-element="foo"]').and_return([])
+          allow(singleton_section).to receive(:find).with('[data-prism-elements="foo"]').and_return(collection_element)
+        end
+
+        it 'creates an element array' do
+          expect(subject.send(section_name).foo).to be_a(Array)
+        end
+      end
+
+      context "for heirarchies of DOM elements with 'data-prism-section' attributes" do
+        let(:baz_section) { make_section('baz', 'data-prism-section') }
+        let(:nested_section_array) { [baz_section] }
+
+        it "creates a heirarchy of sections containing elements" do
+          expect(subject.send(section_name)).to respond_to(:baz)
+        end
+      end
+    end
+
+    context "for 'data-prism-sections' attributes" do
+      let(:collection_name) { 'collection' }
+      let(:section_collection_member) { make_section(collection_name, 'data-prism-sections') }
+      let(:page_sections_array) { [section_collection_member] }
+      let(:foo_element_array) { [] }
+      let(:bar_elements_array) { [] }
+
+      before do
+        allow(page).to receive(:all).with('[data-prism-section]').and_return([])
+        allow(page).to receive(:all).with("[data-prism-sections=\"#{collection_name}\"]").and_return(page_sections_array)
+        allow(page).to receive(:find).with("[data-prism-sections=\"#{collection_name}\"]").and_return(section_collection_member)
+        allow(section_collection_member).to receive(:all).with('[data-prism-element]').and_return(foo_element_array)
+        allow(section_collection_member).to receive(:all).with('[data-prism-elements]').and_return(bar_elements_array)
+        allow(section_collection_member).to receive(:all).with('[data-prism-section]').and_return([])
+        allow(section_collection_member).to receive(:all).with('[data-prism-sections]').and_return([])
+      end
+
+      it "creates an array of sections" do
+        expect(subject.send(collection_name)).to be_a(Array)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: prismatic
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Joe Yates
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: site_prism
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 'Thanks to a naming convention, Prismatic recognises the DOM elements
+  in your web pages that you intend to access during integration tests and automatically
+  creates the intended SitePrism sections and elements. '
+email:
+- joe.g.yates@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/prismatic.rb
+- lib/prismatic/element_container.rb
+- lib/prismatic/page.rb
+- lib/prismatic/section.rb
+- lib/prismatic/version.rb
+- prismatic.gemspec
+- spec/spec_helper.rb
+- spec/unit/prismatic/page_spec.rb
+homepage: https://github.com/joeyates/prismatic
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Automate SitePrism's access to DOM elements
+test_files:
+- spec/spec_helper.rb
+- spec/unit/prismatic/page_spec.rb
+has_rdoc: