ubiquitous 0.0.2 → 0.0.3

data/Gemfile

@@ -2,3 +2,9 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in ubiquitous.gemspec
 gemspec
+
+group :test do
+  gem 'rspec'
+  gem 'actionpack'
+  gem 'rspec-mocks'
+end

data/LICENSE

@@ -1,7 +1,7 @@
-Copyright (C) 2012 Al Grimes
+Copyright (c) 2012 ThoughtWorks, Inc. All rights reserved.
 
 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.
+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

@@ -1,4 +1,4 @@
-A gem to help you generate an acceptance test DSL from your application domain, which then uses Rails ActionView convention of element id generation to find elements in the UI matching the object and method you have called. An example:
+A gem to help you generate an acceptance test DSL from your application domain, which then re-uses Rails ActionView mechanism of element id generation to find elements in the UI matching the object and method you have called, without any boilerplate.  An example:
 
 Say you have a rails model, called Member. Calling the following code from your test:
 
@@ -29,8 +29,16 @@ returns:
 * add the following to your env.rb or spec_helper:
 
     require 'ubiquitous/base_model'
+
 	require 'ubiquitous/model_helpers'
+	
+then for cucumber:
+	
 	World(Ubiquitous::ModelHelpers)
+	
+and for rspec:
+
+    include Ubiquitous::ModelHelpers
 
 
 

data/lib/ubiquitous.rb

@@ -1,5 +1,7 @@
+# Copyright 2012 ThoughtWorks, Inc. Licensed under the MIT License
+
 require "ubiquitous/version"
 
 module Ubiquitous
-  # Your code goes here...
+
 end

data/lib/ubiquitous/base_model.rb

@@ -1,11 +1,12 @@
+# Copyright 2012 ThoughtWorks, Inc. Licensed under the MIT License
+
 module Ubiquitous
   class BaseModel
 
-    def initialize(session, index=0)
+    def initialize(session, index=0, model)
       @session = session
-      @normalised_model_name = self.class.name.gsub "Model", ""
-      models = Dir['app/models/**/*.rb'].map { |f| File.basename(f, '.*').camelize.constantize }
-      @model = models.select { |m| @normalised_model_name == m.to_s }.first.new
+      @normalised_model_name = model.class.name.downcase
+      @model = model
       @index = index
     end
 
@@ -25,7 +26,7 @@ module Ubiquitous
 
     def element_namespace
       require 'action_view/helpers/form_helper'
-      ActionView::Helpers::InstanceTag.new(@normalised_model_name.downcase, @method_name, nil, nil).tag_id_with_index(@index)
+      ActionView::Helpers::InstanceTag.new(@normalised_model_name, @method_name, nil, nil).tag_id_with_index(@index)
     end
 
   end

data/lib/ubiquitous/instance_tag.rb

@@ -1,3 +1,5 @@
+# Copyright 2012 ThoughtWorks, Inc. Licensed under the MIT License
+
 module ActionView
   module Helpers
 
@@ -7,11 +9,7 @@ module ActionView
         "#{sanitized_object_name}_0_#{sanitized_method_name}"
       end
 
-      # No alteration, just making it public
-
-      def tag_id_with_index(index)
-        "#{sanitized_object_name}_#{index}_#{sanitized_method_name}"
-      end
+      public :tag_id_with_index
 
     end
 

data/lib/ubiquitous/model_helpers.rb

@@ -1,20 +1,31 @@
+# Copyright 2012 ThoughtWorks, Inc. Licensed under the MIT License
+
 module Ubiquitous
 
   module ModelHelpers
 
-    models = Dir['app/models/**/*.rb'].map { |f| File.basename(f, '.*').camelize.constantize }
+    def self.models
+      Dir['app/models/**/*.rb'].map { |f| File.basename(f, '.*').camelize.constantize }
+    end
 
-    models.each do |model|
-      class_name = "#{model}Model"
-      Object.const_set(class_name, Class.new(BaseModel))
+    def self.create_classes
+      models.each do |model|
+        class_name = "#{model}Model"
+        Object.const_set(class_name, Class.new(BaseModel))
+      end
     end
 
-  models.each do |model|
-    method_name = (model.to_s.downcase).to_sym
-    send :define_method, method_name do |index=0|
-      "#{model}Model".constantize.new(Capybara.current_session, index)
+    def self.create_helper_methods
+      create_classes
+      models.each do |model|
+        method_name = (model.to_s.downcase).to_sym
+        send :define_method, method_name do |index=0|
+          "#{model}Model".constantize.new(Capybara.current_session, index, model.new)
+        end
+      end
     end
-  end
+
+    create_helper_methods
 
   end
 end

data/lib/ubiquitous/version.rb

@@ -1,3 +1,5 @@
+# Copyright 2012 ThoughtWorks, Inc. Licensed under the MIT License
+
 module Ubiquitous
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/lib/ubiquitous/base_model_spec.rb

@@ -0,0 +1,46 @@
+require 'ubiquitous/base_model'
+require 'action_view'
+require 'action_view/helpers'
+
+describe Ubiquitous::BaseModel do
+
+  before :each do
+    @session = mock
+    @instance_tag_mock = mock(ActionView::Helpers::InstanceTag)
+  end
+
+  it "should attempt to find an element based on model and method name" do
+    @session.should_receive(:find).with(:id, "member_0_surname")
+    @instance_tag_mock.should_receive(:tag_id_with_index).and_return("member_0_surname")
+    ActionView::Helpers::InstanceTag.should_receive(:new).and_return(@instance_tag_mock)
+
+    class Member
+      def surname
+      end
+    end
+
+    member = Ubiquitous::BaseModel.new(@session, 0, Member.new)
+    member.surname
+
+  end
+
+  it "should throw an error if the method doesn't exist on the desired model" do
+
+    class Thingy
+    end
+
+    thingy = Ubiquitous::BaseModel.new(@session, 0, Thingy.new)
+
+    begin
+      thingy.surname
+      raise Exception, "this error means the expected exception wasn't thrown. oh dear."
+    rescue => e
+     e.message.should == "this method, \"surname\" doesn't exist on the Thingy model"
+    end
+
+  end
+
+
+end
+
+

data/spec/lib/ubiquitous/model_helpers_spec.rb

@@ -0,0 +1,44 @@
+require 'ubiquitous/model_helpers'
+require 'ubiquitous/base_model'
+
+describe Ubiquitous::ModelHelpers do
+
+  before :each do
+    class Boat
+    end
+
+    class Car
+    end
+  end
+
+  after :each do
+    Object.send(:remove_const, :BoatModel) if Object.const_defined?(:BoatModel)
+    Object.send(:remove_const, :CarModel) if Object.const_defined?(:CarModel)
+  end
+
+
+  it "should create a new class inheriting BaseModel for every Domain object found" do
+
+    Ubiquitous::ModelHelpers.should_receive(:models).any_number_of_times.and_return([Boat, Car])
+    Ubiquitous::ModelHelpers.create_classes
+    "BoatModel".constantize.should == BoatModel
+    BoatModel.superclass.should == Ubiquitous::BaseModel
+
+  end
+
+  it "should create a helper method for each model" do
+    Ubiquitous::ModelHelpers.should_receive(:models).any_number_of_times.and_return([Boat, Car])
+    Ubiquitous::ModelHelpers.create_helper_methods
+    Object.const_set("Capybara", Class.new)
+    Capybara.should_receive(:current_session).and_return(nil)
+
+    class TestClass
+      include(Ubiquitous::ModelHelpers)
+    end
+
+    TestClass.new.boat.should be_a(BoatModel)
+  end
+
+
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ubiquitous
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-06 00:00:00.000000000Z
+date: 2012-08-07 00:00:00.000000000Z
 dependencies: []
 description: ! "The lofty ambitions of this gem are to unify your ui test and production\n
   \                   code's references to its domain model, and to find elements
@@ -30,6 +30,8 @@ files:
 - lib/ubiquitous/instance_tag.rb
 - lib/ubiquitous/model_helpers.rb
 - lib/ubiquitous/version.rb
+- spec/lib/ubiquitous/base_model_spec.rb
+- spec/lib/ubiquitous/model_helpers_spec.rb
 - ubiquitous.gemspec
 homepage: ''
 licenses: []
@@ -55,4 +57,6 @@ rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: Support to generate a test DSL from your Rails domain objects
-test_files: []
+test_files:
+- spec/lib/ubiquitous/base_model_spec.rb
+- spec/lib/ubiquitous/model_helpers_spec.rb