prismatic 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f0581313ae448d49bcb2922bc29dde490719734
-  data.tar.gz: 2a4cc58f82cf3e92d2cfe4d60421f31e6434004c
+  metadata.gz: b4de90c9626cd6039b1246e18339c836a5ac409d
+  data.tar.gz: 029f05d754e03fb8fda36764af62a9be3223b734
 SHA512:
-  metadata.gz: c8b506871ce9d027a3b92cbe4672d72bdd2095f02a0953a44aa9b8a6f4ec9af609fe9796f37da3b34ac49ffb6adb7d78c0922c260ee531052988d47d7169cdab
-  data.tar.gz: 37999d4ff131a9df65259ca01e6955b4a85ff15ae84d4e44fbe521577f9eb1f05f277ce7756d4200e42032a2613c0ea8a4ac800e6c81d005b88b5e09feb3a2b6
+  metadata.gz: e5b2525abeb7c7b2866120e6a534af28bec2c22ffa5c630e62dee549606537fab2c1497e0554f2d65ce110b47d2fd1ed2e7ba7f65d792477660ceb25a71be141
+  data.tar.gz: 300bb6859b5f788c147bedb17dc9da1df6e661af6cc03675d06054048702152c640c76dcc89fdacf2484298a7c7ee9812bc77074da5750580d2b164e5435c80b

data/.rspec

@@ -1 +1,2 @@
+--order random
 -r spec_helper

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+  - jruby
+  - rbx-2
+script: "bundle exec rake spec"

data/Gemfile

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

data/README.md

@@ -1,5 +1,21 @@
 # Prismatic
 
+[![Build Status](https://secure.travis-ci.org/joeyates/prismatic.png)][Continuous Integration]
+[![Source Analysis](https://codeclimate.com/github/joeyates/prismatic/badges/gpa.svg)][Source Analysis]
+[![Test Coverage](https://codeclimate.com/github/joeyates/prismatic/badges/coverage.svg)][Test Coverage]
+
+  * [Source Code]
+  * [API documentation]
+  * [Rubygem]
+  * [Continuous Integration]
+
+[Source Code]: https://github.com/joeyates/prismatic "Source code at GitHub"
+[API documentation]: http://rubydoc.info/gems/prismatic/frames "RDoc API Documentation at Rubydoc.info"
+[Rubygem]: http://rubygems.org/gems/prismatic "Ruby gem at rubygems.org"
+[Continuous Integration]: http://travis-ci.org/joeyates/prismatic "Build status by Travis-CI"
+[Source Analysis]: https://codeclimate.com/github/joeyates/prismatic "Source code analysis by Code Climate"
+[Test Coverage]: https://codeclimate.com/github/joeyates/prismatic "Test coverage by Code Climate"
+
 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.
@@ -70,25 +86,36 @@ search_page.load
 expect(search_page.search.start.text).to eq('Search')
 ```
 
+## Warnings
+
+* all Pages need an `url_matcher` so that Prismatic knows when a page is
+  actually loaded. If you don't specify one, Prismatic will create it
+  (see `auto_create_url_matcher` configuration setting),
+* be careful with `wait_for_*`: you may need to manually define a section
+  or element you intend to use as a marker that content is loaded - Prismatic
+  won't create them until they are actually present.
+
 ## Configuration
 
 In your test setup, do this:
 
 ```ruby
-Prismatic.configure do |conf|
-  conf.foo = :bar
+Prismatic.configure do
+  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
+  'data-prism-*'. Set prefix to another value to allow data attributes to be
   named differently.
+* auto_create_url_matcher: (default: true). If a Page has no `url_matcher` defined,
+  this sets it to a Regexp based on the Page's `url`.
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/prismatic/fork )
+1. Fork it ( https://github.com/joeyates/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`)

data/lib/prismatic.rb

@@ -4,6 +4,8 @@ require 'site_prism'
 module Prismatic
 end
 
+require 'prismatic/configuration'
+Prismatic.send :extend, Prismatic::Configuration
 require 'prismatic/element_container'
 require 'prismatic/page'
 require 'prismatic/section'

data/lib/prismatic/configuration.rb

@@ -0,0 +1,31 @@
+require 'docile'
+
+module Prismatic::Configuration
+  OPTIONS_AND_DEFAULTS = {
+    prefix:                  'prism',
+    auto_create_url_matcher: true,
+  }
+
+  OPTIONS_AND_DEFAULTS.each do |option, default|
+    define_method option do |value = :no_value_supplied|
+      v = "@#{option}"
+      if instance_variable_defined?(v) and value == :no_value_supplied
+        return instance_variable_get(v)
+      end
+      new_value = value == :no_value_supplied ? default : value
+      instance_variable_set(v, new_value)
+    end
+  end
+
+  def configure(&block)
+    Docile.dsl_eval(self, &block)
+  end
+
+  def reset_configuration
+    OPTIONS_AND_DEFAULTS.each do |option, default|
+      v = "@#{option}"
+      instance_variable_set(v, default)
+    end
+    true
+  end
+end

data/lib/prismatic/element_container.rb

@@ -1,7 +1,7 @@
 module Prismatic::ElementContainer
   private
 
-  def create_elements
+  def update_elements
     find_matches 'element'
     find_matches 'elements'
     find_matches 'section'
@@ -13,6 +13,7 @@ module Prismatic::ElementContainer
 
     find_all("[#{attribute}]").each do |el|
       name = el[attribute]
+      next if has_instance_method?(self.class, name)
       if is_section?(type)
         self.class.send type.intern, name, Prismatic::Section, "[#{attribute}=\"#{name}\"]"
       else
@@ -26,6 +27,10 @@ module Prismatic::ElementContainer
   end
 
   def attribute_for(type)
-    "data-prism-#{type}"
+    "data-#{Prismatic.prefix}-#{type}"
+  end
+
+  def has_instance_method?(klass, method)
+    klass.instance_methods.include?(method.intern)
   end
 end

data/lib/prismatic/page.rb

@@ -3,6 +3,32 @@ class Prismatic::Page < SitePrism::Page
 
   def load
     super
-    create_elements
+    optionally_update_elements
+  end
+
+  def respond_to?(method_id, include_all = false)
+    optionally_update_elements
+    methods.include?(method_id)
+  end
+
+  def method_missing(method_id, *args)
+    optionally_update_elements
+    return super unless methods.include?(method_id)
+    send(method_id, *args)
+  end
+
+  private
+
+  def optionally_update_elements
+    optionally_set_url_matcher
+    return unless displayed?(0)
+    update_elements
+  end
+
+  def optionally_set_url_matcher
+    return unless self.class.url_matcher.nil?
+    return if self.class.url.nil?
+    return unless Prismatic.auto_create_url_matcher
+    self.class.set_url_matcher %r(^https?://[^/]+#{self.class.url}([#\?].*)?$)
   end
 end

data/lib/prismatic/section.rb

@@ -3,6 +3,6 @@ class Prismatic::Section < SitePrism::Section
 
   def initialize(parent, root_element)
     super
-    create_elements
+    update_elements
   end
 end

data/lib/prismatic/version.rb

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

data/prismatic.gemspec

@@ -23,8 +23,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'site_prism', '~> 2.6'
+  spec.add_dependency 'docile', '~> 1.1'
 
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'codeclimate-test-reporter', '~> 0.4'
 end

data/spec/spec_helper.rb

@@ -1,5 +1,18 @@
 require 'rspec'
+require 'codeclimate-test-reporter'
+
 spec_path = File.dirname(__FILE__)
 $LOAD_PATH << File.expand_path('../lib', spec_path)
 
+SimpleCov.start do
+  formatter SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter,
+    CodeClimate::TestReporter::Formatter
+  ]
+  SimpleCov.start do
+    add_filter '/spec/'
+    add_filter '/vendor/'
+  end
+end
+
 require 'prismatic'

data/spec/unit/prismatic/configuration_spec.rb

@@ -0,0 +1,54 @@
+require 'prismatic'
+
+describe Prismatic::Configuration do
+  after do
+    Prismatic.reset_configuration
+  end
+
+  [
+    [:prefix,                  'prism', 'foo'],
+    [:auto_create_url_matcher, true,    false],
+  ].each do |option, default, new_value|
+    describe "##{option}" do
+      it 'returns the value' do
+        expect(Prismatic.send(option)).to eq(default)
+      end
+
+      context 'setting' do
+        it 'sets the value' do
+          Prismatic.send(option, new_value)
+          expect(Prismatic.send(option)).to eq(new_value)
+        end
+
+        it "accepts 'nil'" do
+          Prismatic.send(option, nil)
+          expect(Prismatic.send(option)).to eq(nil)
+        end
+
+        it 'returns the value' do
+          expect(Prismatic.send(option, new_value)).to eq(new_value)
+        end
+      end
+    end
+  end
+
+  context '.configure' do
+    it 'sets values in the block' do
+      Prismatic.configure do
+        prefix 'bar'
+      end
+
+      expect(Prismatic.prefix).to eq('bar')
+    end
+  end
+
+  context '.reset_configuration' do
+    it 'resets options to defaults' do
+      Prismatic.prefix 'aaaaaaa'
+
+      Prismatic.reset_configuration
+
+      expect(Prismatic.prefix).to eq('prism')
+    end
+  end
+end

data/spec/unit/prismatic/page_spec.rb

@@ -1,7 +1,3 @@
-class MyPage < Prismatic::Page
-  set_url '/'
-end
-
 describe Prismatic::Page do
   def make_element(name, attribute)
     el = double(Capybara::Node::Element)
@@ -15,7 +11,11 @@ describe Prismatic::Page do
     el
   end
 
-  let(:page) { double(Capybara::Session, visit: nil) }
+  let(:page) { double(Capybara::Session, visit: nil, current_url: current_url) }
+  let(:current_url) { non_matching_url } # this means the page is not displayed
+  let(:matching_url) { 'http://example.com/search' }
+  let(:non_matching_url) { 'http://example.com/quux' }
+
   let(:page_element_array) { [] }
   let(:page_elements_array) { [] }
   let(:page_section_array) { [] }
@@ -23,28 +23,73 @@ describe Prismatic::Page do
   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
 
-  describe '#load' do
-    subject do
-      page = MyPage.new
-      page.load
-      page
+  # As 'url' and 'url_matcher' get set on the class itself,
+  # we use different subclasses for each example
+  let(:klass) do
+    Class.new(Prismatic::Page) do
+      set_url '/search'
     end
+  end
+  subject { klass.new }
+
+  specify { expect(subject).to be_a(SitePrism::Page) }
+
+  context 'configuration' do
+    let(:current_url) { matching_url }
+    let(:prefix) { 'hello' }
+    let(:singleton_element) { make_element('foo', "data-#{prefix}-element") }
 
     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)
+      allow(page).to receive(:all).with("[data-#{prefix}-element]").and_return([singleton_element])
+      allow(page).to receive(:all).with("[data-#{prefix}-elements]").and_return([])
+      allow(page).to receive(:all).with("[data-#{prefix}-section]").and_return([])
+      allow(page).to receive(:all).with("[data-#{prefix}-sections]").and_return([])
+      allow(page).to receive(:find).with("[data-#{prefix}-element=\"foo\"]").and_return(singleton_element)
     end
 
+    after { Prismatic.reset_configuration }
+
+    context 'when a prefix is configured' do
+      before { Prismatic.prefix prefix }
+
+      it 'is used' do
+        subject.load
+        expect(subject.foo).to be(singleton_element)
+      end
+    end
+
+    context 'when auto_create_url_matcher is set to false' do
+      before { Prismatic.auto_create_url_matcher false }
+
+      it 'fails to create elements' do
+        expect do
+          subject.load
+        end.to raise_error
+      end
+    end
+  end
+
+  describe '#load' do
+    let(:current_url) { matching_url }
+
     context "for 'data-prism-element' attributes" do
       let(:page_element_array) { [singleton_element] }
 
+      before do
+        allow(page).to receive(:find).with("[data-prism-element=\"foo\"]").and_return(singleton_element)
+        subject.load
+      end
+
       it "creates a single element" do
-        expect(subject).to respond_to('foo')
+        expect(subject.foo).to be(singleton_element)
       end
     end
 
@@ -54,6 +99,7 @@ describe Prismatic::Page do
 
       before do
         allow(page).to receive(:all).with('[data-prism-elements="bar"]').and_return(bar_elements_array)
+        subject.load
       end
 
       it "creates an arrays of elements" do
@@ -80,8 +126,12 @@ describe Prismatic::Page do
           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)
+        context 'the section' do
+          before { subject.load }
+
+          it "is created" do
+            expect(subject.send(section_name.intern)).to be_a(Prismatic::Section)
+          end
         end
 
         context "with contained 'data-prism-element' attributes" do
@@ -89,7 +139,8 @@ describe Prismatic::Page do
 
           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([])
+            allow(singleton_section).to receive(:find).with('[data-prism-elements="bar"]').and_return([])
+            subject.load
           end
 
           it 'creates an element' do
@@ -101,14 +152,15 @@ describe Prismatic::Page 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(:all).with('[data-prism-element="foo"]').and_return([])
+            allow(singleton_section).to receive(:all).with('[data-prism-elements="bar"]').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)
+            allow(singleton_section).to receive(:find).with('[data-prism-elements="bar"]').and_return(collection_element)
+            subject.load
           end
 
           it 'creates an element array' do
-            expect(subject.send(section_name).foo).to be_a(Array)
+            expect(subject.send(section_name).bar).to be_a(Array)
           end
         end
 
@@ -116,6 +168,8 @@ describe Prismatic::Page do
           let(:baz_section) { make_section('baz', 'data-prism-section') }
           let(:nested_section_array) { [baz_section] }
 
+          before { subject.load }
+
           it "creates a heirarchy of sections containing elements" do
             expect(subject.send(section_name)).to respond_to(:baz)
           end
@@ -137,6 +191,7 @@ describe Prismatic::Page do
           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([])
+          subject.load
         end
 
         it "creates an array of sections" do
@@ -145,4 +200,103 @@ describe Prismatic::Page do
       end
     end
   end
+
+  shared_examples 'optionally creates elements' do |action|
+    context 'when the page is not displayed' do
+      let(:current_url) { non_matching_url }
+
+      before do
+        allow(page).to receive(:all)
+        action.call subject
+      end
+
+      it 'does nothing' do
+        expect(page).to_not have_received(:all)
+      end
+    end
+
+    context 'when the page is displayed' do
+      let(:current_url) { matching_url }
+      let(:page_element_array) { [singleton_element] }
+
+      before do
+        allow(page).to receive(:all).with("[data-prism-element]").and_return([singleton_element])
+        allow(page).to receive(:find).with("[data-prism-element=\"foo\"]").and_return(singleton_element)
+        action.call subject
+      end
+
+      it 'creates elements' do
+        # stop elements being created:
+        allow(page).to receive(:find).with("[data-prism-element]").and_return([])
+        expect(subject.foo).to be(singleton_element)
+      end
+    end
+  end
+
+  describe '#respond_to?' do
+    action = ->(subject) { subject.respond_to?(:baz) }
+    include_examples 'optionally creates elements', action
+  end
+
+  describe '#method_missing' do
+    action = ->(subject) { subject.baz rescue nil }
+    include_examples 'optionally creates elements', action
+
+    context 'with truly missing methods' do
+      specify 'raise an error' do
+        expect do
+          subject.baz
+        end.to raise_error(NoMethodError)
+      end
+    end
+
+    context 'on-the-fly methods' do
+      let(:current_url) { matching_url }
+      let(:page_element_array) { [singleton_element] }
+
+      before do
+        allow(page).to receive(:all).with("[data-prism-element]").and_return([singleton_element])
+        allow(page).to receive(:find).with("[data-prism-element=\"foo\"]").and_return(singleton_element)
+      end
+
+      specify 'get called' do
+        expect(subject.foo).to eq(singleton_element)
+      end
+    end
+  end
+
+  context 'on-the-fly methods' do
+    let(:current_url) { matching_url }
+    let(:page_element_array) { [singleton_element] }
+
+    before do
+      allow(page).to receive(:all).with("[data-prism-element]").and_return([singleton_element])
+      allow(page).to receive(:find).with("[data-prism-element=\"foo\"]").and_return(singleton_element)
+    end
+
+    specify "don't replace existing methods" do
+      subject.class.send(:define_method, :foo) { 'hello' }
+
+      subject.baz rescue nil
+
+      expect(subject.foo).to eq('hello')
+    end
+
+    context 'with dynamic content' do
+      specify 'missing methods are created on successive updates' do
+        # Initially it's not there:
+        allow(page).to receive(:all).with("[data-prism-element]").and_return([])
+        subject.baz rescue nil
+
+        expect(subject.methods).to_not include(:foo)
+
+        # Then it appears:
+        allow(page).to receive(:all).with("[data-prism-element]").and_return([singleton_element])
+        subject.baz rescue nil
+
+        expect(subject.methods).to include(:foo)
+        expect(subject.foo).to eq(singleton_element)
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prismatic
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Joe Yates
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-18 00:00:00.000000000 Z
+date: 2014-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: site_prism
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: docile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
 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. '
@@ -77,17 +105,20 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/prismatic.rb
+- lib/prismatic/configuration.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/configuration_spec.rb
 - spec/unit/prismatic/page_spec.rb
 homepage: https://github.com/joeyates/prismatic
 licenses:
@@ -115,5 +146,6 @@ specification_version: 4
 summary: Automate SitePrism's access to DOM elements
 test_files:
 - spec/spec_helper.rb
+- spec/unit/prismatic/configuration_spec.rb
 - spec/unit/prismatic/page_spec.rb
 has_rdoc: