page_record 0.0.1

data/spec/page_record_spec.rb

@@ -0,0 +1,434 @@
+require_relative  './spec_helper'
+
+describe PageRecord::PageRecord do
+
+	include_context "page with single table with 3 records" # Default context
+
+	before do
+	  class TeamPage < PageRecord::PageRecord; end
+		PageRecord::PageRecord.page = page
+	end
+
+  describe ".type" do
+
+  	before do
+	  	class CamelCase
+				def self.attribute_names
+					[ 'id' , 'name', 'points', 'ranking', 'goals']
+				end
+			end
+			class CamelCasePage < PageRecord::PageRecord; end
+		end
+
+		it "returns the internal type of the class" do
+			pending
+			expect( CamelCasePage.type).to eq "camel_case"
+		end
+
+  end
+
+
+  describe ".attributes" do
+  	before do
+		  class TeamPage < PageRecord::PageRecord
+				attributes ['country', 'stadium']
+		  end
+  	end
+
+  	after do
+			Object.send(:remove_const, :TeamPage)
+  	end
+
+  	subject { TeamPage}
+
+  	it "clears all old class methods" do
+			expect(subject).not_to respond_to(:find_by_name)  		
+			expect(subject).not_to respond_to(:find_by_ranking)  		
+  	end
+
+  	it "adds new class methods to class " do
+			expect(subject).to respond_to(:find_by_country)
+			expect(subject).to respond_to(:find_by_stadium)	
+  	end
+
+  	it "clears all old instance methods" do
+			expect(subject.new(1)).not_to respond_to(:name)  		
+			expect(subject.new(1)).not_to respond_to(:ranking)  		
+  	end
+
+  	it "adds new class methods to class " do
+			expect(subject.new(1)).to respond_to(:country)
+			expect(subject.new(1)).to respond_to(:stadium)	
+  	end
+
+  end
+
+
+
+  describe ".page=" do
+  	before do
+  		PageRecord::PageRecord.page = nil # reset for the spec
+  	end
+
+  	subject {PageRecord::PageRecord.page = page }
+
+  	it "sets the page when called on PageRecord::PageRecord" do
+			expect{PageRecord::PageRecord.page = page}.to change{PageRecord::PageRecord.page}.from(nil).to(page)  		
+  	end
+
+  	it "sets the page when called on subclass" do
+			expect{TeamPage.page = page}.to change{PageRecord::PageRecord.page}.from(nil).to(page)  		
+  	end
+
+
+  end
+
+  describe ".page" do
+
+
+  	it "gets the page on PageRecord::PageRecord" do
+			expect(PageRecord::PageRecord.page).to eq page  		
+  	end
+
+  	it "gets the page on subclass" do
+			expect(TeamPage.page).to eq page  		
+  	end
+
+  end
+
+
+
+	describe ".all" do
+
+
+		subject {TeamPage.all( selector, filter) }
+
+		context "one set of records available on the page" do
+			let(:selector)	{""}
+			let(:filter)	{""}
+
+			it_behaves_like "valid call of .all"
+
+			context "with a filter" do
+				let(:filter)	{".champions_league"}
+
+					it "returns only the elements that contain the filter css" do
+						expect( subject.map {|c| c.name}).not_to include('Feijenoord')
+						expect( subject.map {|c| c.name}).to include(*['Ajax', 'PSV'])
+					end
+
+
+			end
+
+
+		end
+
+		context "No records available on the page" do
+
+			include_context "page without records"
+			let(:selector)	{""}
+			let(:filter)	{""}
+
+
+			it "returns an empty Array" do
+				expect(subject).to eq []
+			end
+
+		end
+
+		context "multiple sets of records avialable on the page" do
+			include_context "page with two tables with 3 records" 
+
+			context "without selector" do
+				let(:selector)	{""}
+				let(:filter)	{""}
+
+
+				it "raises error PageRecord::MultipleRecords" do
+					expect{subject}.to raise_error(PageRecord::MultipleRecords)
+				end
+
+			end
+
+			it_behaves_like "handles invalid selectors"
+
+			context "with a correct selector" do
+
+				let(:selector)	{"#first-table"}
+				let(:filter)	{""}
+
+				it_behaves_like "valid call of .all"
+
+			end
+
+		end
+
+	end	
+
+
+	describe "inherited class" do
+
+		subject {TeamPage.new(1) }
+
+			it "responds to all attributes of corresponding AR Class" do
+				Team.attribute_names.each do |attribute|
+					expect(subject).to respond_to(attribute)
+				end
+			end
+
+			it "responds <attribute>? of corresponding AR Class" do
+				Team.attribute_names.each do |attribute|
+					expect(subject).to respond_to("#{attribute}?")
+				end
+			end
+
+			#
+			# Checks a bug
+			it "leaves attribute_names of host class intact"
+
+
+	end
+
+	describe "action method on class" do
+		pending
+	end
+
+
+	describe ".find" do
+
+		subject {TeamPage.find(record_number, selector, filter) }
+		let(:selector) { ""}
+		let(:filter) {""}
+
+		context "find without an id" do
+			pending
+		end
+
+		context "one found on the page" do
+
+			let(:record_number) { 1}
+
+			it_behaves_like "a valid call of .find"
+
+
+			it_behaves_like "it handles filters"
+
+
+		end
+
+		context "multiple record found on the page" do
+
+			let(:record_number) { 1}
+			include_context "page with duplicate records"
+
+			subject {TeamPage.find(1) }
+
+			it "raises error PageRecord::MultipleRecords" do
+				expect{subject}.to raise_error(PageRecord::MultipleRecords)
+			end
+
+		end
+
+
+		context "no record on the page" do
+
+			let(:record_number) { 37373}
+
+			it "raises error PageRecord::RecordNotFound" do
+				expect{subject}.to raise_error(PageRecord::RecordNotFound)
+			end
+
+		end
+
+		context "multiple sets of records available on the page" do
+			include_context "page with two tables with 3 records" 
+			let(:record_number) {1}
+
+			context "without selector" do
+				let(:selector)	{""}
+
+				it "raises error PageRecord::MultipleRecords" do
+					expect{subject}.to raise_error(PageRecord::MultipleRecords)
+				end
+
+			end
+
+			it_behaves_like "handles invalid selectors"
+
+			context "with a correct selector" do
+
+				let(:selector)	{"#first-table"}
+				it_behaves_like "a valid call of .find"
+
+			end
+
+		end
+
+	end	
+
+	describe "find_by..." do
+
+		subject { TeamPage.find_by_name(name, selector, filter)}
+		let(:selector) { ""}
+		let(:filter) {""}
+
+		context "no record on page" do
+			let(:name) {"unknown name"}
+
+			it "raises error PageRecord::RecordNotFound" do
+				expect{subject}.to raise_error(PageRecord::RecordNotFound)
+			end
+
+		end
+
+		context "multiple records on page" do
+			let(:name) {"Ajax"}
+			include_context "page with duplicate records"
+
+			it "raises error PageRecord::MultipleRecords" do
+				expect{subject}.to raise_error(PageRecord::MultipleRecords)
+			end
+
+		end
+
+		context "one record on page" do
+			let(:name) {"Ajax"}
+
+			it_behaves_like "a valid call of .find"
+			it_behaves_like "it handles filters"
+
+		end
+
+		context "multiple sets of records avialable on the page" do
+			include_context "page with two tables with 3 records" 
+			let(:name) {"Ajax"}
+
+			context "without selector" do
+				let(:selector)	{""}
+
+				it "raises error PageRecord::MultipleRecords" do
+					expect{subject}.to raise_error(PageRecord::MultipleRecords)
+				end
+
+			end
+
+			it_behaves_like "handles invalid selectors"
+
+			context "with a correct selector" do
+
+				let(:selector)	{"#first-table"}
+				let(:name) {"Ajax"}
+				it_behaves_like "a valid call of .find"
+
+			end
+
+		end
+
+
+
+	end
+
+	describe "#...? " do
+
+		subject {TeamPage.find(1)}
+
+		context "attribute is on page" do
+
+			it "returns the dom object" do
+				expect( subject.name?.class).to eq Capybara::Node::Element
+			end
+		end
+
+		context "attribute not on page" do
+
+			it "raises error PageRecord::AttributeNotFound" do
+				expect{subject.goals?}.to raise_error(PageRecord::AttributeNotFound)
+			end
+
+		end
+	end
+
+	describe "#... valid attribute getter" do
+
+		subject {TeamPage.find(1)}
+  	include_context "page with single table with 3 records"
+
+		context "attribute is on page" do
+
+			it "returns a the value on the page" do
+				expect( subject.name).to eq 'Ajax'
+			end
+		end
+
+		context "attribute not on page" do
+
+			it "raises error PageRecord::AttributeNotFound" do
+				expect{subject.goals}.to raise_error(PageRecord::AttributeNotFound)
+			end
+
+		end
+
+
+	end
+
+	describe "#... valid attribute setter" do
+
+		subject {record.name = 'FC Utrecht'}
+		let(:record) { TeamPage.find(1)}
+
+
+		context "attribute is an input field" do
+	  	include_context "page one record in a form"
+
+			it "sets the attribute to specified value" do
+				expect{subject}.to change{record.name}.from(nil).to('FC Utrecht')
+			end
+		end
+
+		context "attribute is an input field" do
+	  	include_context "page one record"
+
+			it "raises error PageRecord::NotInputField" do
+				expect{subject}.to raise_error(PageRecord::NotInputField)
+			end
+
+		end
+
+	end
+
+	describe "#... action methods" do
+
+		let(:record) { TeamPage.find(1)}
+  	include_context "page one record in a form"
+
+		context "action exists on page" do
+			subject {record.create}
+
+			it "clicks on the specified action element" do
+				expect{subject}.not_to raise_error(PageRecord::NotInputField) # TODO can we make it better?
+			end
+
+
+		end
+
+		context "action doesn't exist on page" do
+			subject {record.unkown}
+
+			it "raises error NoMethodError" do
+				expect{subject}.to raise_error(NoMethodError)
+			end
+		end
+
+
+	end
+
+	describe "#...? action methods" do
+		pending
+	end
+
+	describe ".attributes" do
+		pending
+	end
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,33 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'coveralls'
+Coveralls.wear!
+require 'page_record'
+require 'capybara'
+require 'capybara/dsl'
+include Capybara::DSL
+
+require_relative './support/test_app'
+require_relative './support/team'
+require_relative './support/shared_contexts'
+require_relative './support/shared_examples'
+
+Capybara.app = TestApp
+Capybara.app_host = nil
+
+
+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
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/support/shared_contexts.rb

@@ -0,0 +1,37 @@
+shared_context "page with single table with 3 records" do
+  before do
+    visit "/page-with-single-table-with-3-records"
+  end
+end
+
+shared_context "page with two tables with 3 records" do
+  before do
+    visit "/page-with-two-tables-with-3-records"
+  end
+end
+
+
+shared_context "page without records" do
+  before do
+    visit "/page-without-records"
+  end
+end
+
+shared_context "page with duplicate records" do
+  before do
+    visit "/page-with-duplicate-records"
+  end
+end
+
+shared_context "page one record in a form" do
+  before do
+    visit "/page-one-record-in-a-form"
+  end
+end
+
+
+shared_context "page one record" do
+  before do
+    visit "/page-one-record"
+  end
+end

data/spec/support/shared_examples.rb

@@ -0,0 +1,71 @@
+shared_examples "valid call of .all" do
+
+	it "returns an Array" do
+		expect(subject.class).to eq Array
+	end
+
+	it "returns the inheriting class in the Array" do
+		subject.each do |record|
+			expect( record.class).to eq TeamPage
+		end
+	end
+
+	it "returns an element for each record on the page" do
+		expect( subject.count).to eq 3
+	end
+
+end
+
+
+shared_examples "it handles filters" do
+	context "specified record contains specified filter" do
+		let(:filter)	{".champions_league"}
+
+		it_behaves_like "a valid call of .find"
+
+	end
+
+	context "specified record doesn't contain specified filter" do
+		let(:filter)	{".euro_league"}
+
+		it "raises error PageRecord::RecordNotFound" do
+			expect{subject}.to raise_error(PageRecord::RecordNotFound)
+		end
+	end
+end
+
+
+shared_examples "handles invalid selectors" do
+	context "with an non existing selector" do
+
+		let(:selector)	{"#non-existing-table"}
+		let(:filter)		{""}
+
+
+		it "raises error PageRecord::RecordNotFound" do
+			expect{subject}.to raise_error(PageRecord::RecordNotFound)
+		end
+	end
+
+	context "with an undetermined selector" do
+
+		let(:selector)	{".team-table"}
+		let(:filter)	{""}
+
+
+		it "raises error PageRecord::MultipleRecords" do
+			expect{subject}.to raise_error(PageRecord::MultipleRecords)
+		end
+
+	end
+end
+
+shared_examples "a valid call of .find" do
+	it "returns the inheriting class" do
+		expect(subject.class).to eq TeamPage
+	end
+
+	it "returns the record identified by the id" do
+		expect(subject.id).to eq '1'
+	end
+end

data/spec/support/team.rb

@@ -0,0 +1,6 @@
+# @private This is just a class for testing
+class Team
+	def self.attribute_names
+		[ 'id' , 'name', 'points', 'ranking', 'goals']
+	end
+end

data/spec/support/test_app.rb

@@ -0,0 +1,24 @@
+require 'sinatra/base'
+
+
+# @private This is just a test class
+class TestApp < Sinatra::Base
+
+  set :root, File.dirname(__FILE__)
+  set :raise_errors, true
+  # set :show_exceptions, false
+
+
+  get '/*' do
+	  viewname = params[:splat].first   # eg "some/path/here"
+	  if File.exist?("#{settings.root}/views/#{viewname}.erb")
+	    erb :"#{viewname}"
+	  else
+	  	"can't find view #{viewname}"
+	  end
+	end
+end
+
+if __FILE__ == $0
+  Rack::Handler::WEBrick.run TestApp, :Port => 8070
+end

data/spec/support/views/page-one-record-in-a-form.erb

@@ -0,0 +1,4 @@
+<form data-team-id='1'>
+	<input data-attribute-for='name'>
+	<button data-action-for='create'>
+</form>

data/spec/support/views/page-one-record.erb

@@ -0,0 +1,3 @@
+<div data-team-id='1'>
+  <div data-attribute-for='name'></div>
+</div>

data/spec/support/views/page-with-duplicate-records.erb

@@ -0,0 +1,8 @@
+<table>
+<tr data-team-id='1'>
+  <td data-attribute-for='name'>Ajax</td>
+</tr>
+<tr data-team-id='1'>
+  <td data-attribute-for='name'>Ajax</td>
+</tr>
+</table>

data/spec/support/views/page-with-single-table-with-3-records.erb

@@ -0,0 +1,17 @@
+<table>
+  <tr data-team-id='1' class='champions_league'>
+    <td data-attribute-for='ranking'>1</td>
+    <td data-attribute-for='name'>Ajax</td>
+    <td data-attribute-for='points'>10</td>
+  </tr>
+  <tr data-team-id='2' class='champions_league'>
+    <td data-attribute-for='ranking'>2</td>
+    <td data-attribute-for='name'>PSV</td>
+    <td data-attribute-for='points'>8</td>
+  </tr>
+  <tr data-team-id='3'>
+    <td data-attribute-for='ranking'>3</td>
+    <td data-attribute-for='name'>Feijenoord</td>
+    <td data-attribute-for='points'>6</td>
+  </tr>
+</table>

data/spec/support/views/page-with-two-tables-with-3-records.erb

@@ -0,0 +1,38 @@
+<div class='team-table'>
+  <table id='first-table'>
+    <tr data-team-id='1' class='champions_league'>
+      <td data-attribute-for='ranking'>1</td>
+      <td data-attribute-for='name'>Ajax</td>
+      <td data-attribute-for='points'>10</td>
+    </tr>
+    <tr data-team-id='2' class='champions_league'>
+      <td data-attribute-for='ranking'>2</td>
+      <td data-attribute-for='name'>PSV</td>
+      <td data-attribute-for='points'>8</td>
+    </tr>
+    <tr data-team-id='3' class='euro_league'>
+      <td data-attribute-for='ranking'>3</td>
+      <td data-attribute-for='name'>Feijenoord</td>
+      <td data-attribute-for='points'>6</td>
+    </tr>
+  </table>
+</div>
+<div class='team-table'>
+  <table id='second-table'>
+    <tr data-team-id='1' class='champions_league'>
+      <td data-attribute-for='ranking'>1</td>
+      <td data-attribute-for='name'>Ajax</td>
+      <td data-attribute-for='points'>10</td>
+    </tr>
+    <tr data-team-id='2' class='champions_league'>
+      <td data-attribute-for='ranking'>2</td>
+      <td data-attribute-for='name'>PSV</td>
+      <td data-attribute-for='points'>8</td>
+    </tr>
+    <tr data-team-id='3' class='euro_league'>
+      <td data-attribute-for='ranking'>3</td>
+      <td data-attribute-for='name'>Feijenoord</td>
+      <td data-attribute-for='points'>6</td>
+    </tr>
+  </table>
+</div>

data/spec/support/views/page-without-records.erb

@@ -0,0 +1,2 @@
+<table>
+</table