kameleon 0.0.9 → 0.2.0.alpha.2

data/LICENCE

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Michał Czyż <http://linkd.in/michalczyz> @cs3b
+Copyright (c) 2011..2012 Michał Czyż <http://linkd.in/michalczyz> @cs3b
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.textile

@@ -0,0 +1,157 @@
+h1. Kameleon [chameleon]
+
+"!https://secure.travis-ci.org/cs3b/kameleon.png?branch=master!":http://travis-ci.org/cs3b/kameleon
+
+Kameleon is a high abstraction dsl for better writing acceptance and integrationtests using Capybara.
+And "better" means: more easily to mimic how user interact with browser.
+
+h2. Setup:
+
+Kameleon requires:
+* rspec
+* capybara
+
+Optional is nice to use
+* devise ( Kameleon uses paths suplied by devise. So if you're using some other authentication solution, you might want to overwrite it )
+* selenium-wedriver && capybara-webkit for testing full site
+* thin (if you want run your specs faster - add gem 'thin' to Gemfile in your app)
+
+Gemfile
+
+<pre>
+gem 'kameleon', '>= 0.2.0'
+</pre>
+
+Before you start using Kameleon ensure that capybara is properly loaded (in your test helper file)
+
+<pre>
+require 'kameleon/ext/rspec/all'
+</pre>
+
+or just components you want, kemeleon/ext/rspec/all by default loads:
+
+<pre>
+require 'kameleon/ext/rspec/dsl'
+require 'kameleon/ext/rspec/garbage_collector'
+require 'kameleon/ext/rspec/headless'
+</pre>
+
+h2. Usage:
+
+below few examples for more please check spec/integration tests suite
+
+bc. background do
+      @admin = Factory.create(:user)
+    end
+
+    scenario "opening list of news", :status => 'done' do
+      click "homepage",
+            "community",
+            "news"
+
+      see "new medicine developed last weekend"
+      within(:row => 'some cell text') do
+        see 'see all values in row that contains that text'
+      end
+      see :ordered => 'Z', 'X', 'Y'
+      click :and_confirm => "Cancel", :and_dismiss => "Cancel"
+    end
+
+Another example
+
+bc.   feature "Products", :driver => :selenium do
+          background do
+            @admin = Factory.create(:user)
+            create_session(:admin)
+            visit spree.admin_path
+          end
+
+          context "listing products" do
+            scenario "products sorting" do
+              Factory(:product, :name => 'apache baseball cap',
+                                :available_on => '2011-01-06 18:21:13:',
+                                :count_on_hand => '0')
+              Factory(:product, :name => 'zomg shirt',
+                                :available_on => '2125-01-06 18:21:13',
+                                :count_on_hand => '5')
+
+              act_as(:admin) do
+                click "Products"
+                see :ordered => ["apache baseball cap", "zomg shirt"]
+
+                click "admin_products_listing_name_title"
+                see :ordered => ["zomg shirt", "apache baseball cap"]
+              end
+            end
+          end
+
+And more complex example, with two user sessions:
+
+bc.    scenario "admin adds a product and user buys it", :status => "done", :driver => :selenium do
+          create_session(:admin)
+          @admin = Factory.create(:admin_user)
+          create_session(:user)
+
+          act_as(:admin) do
+            visit spree.admin_path
+            click "Products", "admin_new_product"
+            within('#new_product') do
+              see "SKU"
+            end
+            fill_in "product_name" => "Baseball Cap",
+                    "product_sku" => "B100",
+                    "product_price"=> "100",
+                    "product_available_on"=> "2012/01/24"
+
+            click "Create"
+            see "successfully created!"
+
+            fill_in "product_on_hand" => "100"
+            click "Update"
+            see "successfully updated!"
+          end
+
+          act_as(:user) do
+            visit spree.root_path
+            click "Baseball Cap", "add-to-cart-button", "Checkout"
+            within("span.out-of-stock") do
+              see "Baseball Cap added to your cart"
+            end
+          end
+        end
+
+
+h2. Tips & Tricks:
+* You have access to page variable. So if you think that something cannot be accomplished by the Kameleon DSL, you can just write using RSpec matchers and page variable. Like this: <pre>  page.should have_css("li.banner_message", :count => 10) </pre>  Of course, after you've submitted feature request to the owner of the original repository ;)
+* It is handy to define a common set of areas, that user often follows navigating on the site. Here is an example:
+<pre> Kameleon::Session.defined_areas.merge!({
+                                           :menu => [:xpath, "//nav/ul"],
+                                           :main => '.main_body',
+                                           :right_column => '.col_aside',
+                                           :ordered_list => '.ordered_list',
+                                           :favourites => '.favourites_list',
+                                           :gallery_tiny => '.gallery_tiny',
+                                           :gallery_list => '.gallery_list',
+                                           :content => '.col_content',
+                                           :col_aside => '.col_aside'
+                                       })
+
+</pre>
+
+soon we will merge with new capybara approach for that
+
+h2. Tips & Tricks:
+
+h3. Session pooling
+
+Kameleon has useful technique of session pooling implemented, that can speed up test suite greatly.
+In order to enable it, you need to pass this to the RSpec.configure block, in spec_helper.rb:
+
+bc. config.after(:each) do
+  ::SessionPool.release_all
+end
+
+h2. Credits:
+* <a href="http://selleo.com/people/michal-czyz">Michał Czyż</a>
+* <a href="http://selleo.com/people/radoslaw-jedryszczak">Radosław Jędryszczak</a>
+* <a href="http://selleo.com/people">Szymon Kieloch</a>

data/lib/kameleon.rb

@@ -1,22 +1,7 @@
 require 'kameleon/utils/configuration'
-require 'kameleon/utils/helpers'
-
-require 'kameleon/session/capybara'
-require 'kameleon/session/server'
-require 'kameleon/session/session_pool'
-require 'kameleon/dsl/see'
-require 'kameleon/dsl/act'
-
-require 'kameleon/user/abstract'
-require 'kameleon/user/base'
-require 'kameleon/user/guest'
-
 
 module Kameleon
-  extend Utils::Configuration
-end
-
-# Set up default configuration for Kameleon
-Kameleon.configure do |config|
-  config.default_file_path = 'spec/dummy'
+  def self.configure(&block)
+    yield(Kameleon::Utils::Configuration)
+  end
 end

data/lib/kameleon/dsl.rb

@@ -0,0 +1,98 @@
+require 'kameleon/dsl/verify/presence'
+require 'kameleon/dsl/verify/absence'
+
+require 'kameleon/dsl/act/mouse'
+require 'kameleon/dsl/act/form'
+
+require 'kameleon/ext/capybara/session_pool'
+require 'kameleon/session'
+
+require 'kameleon/dsl/context/scope'
+
+module Kameleon
+  module DSL
+
+    def see(*args)
+      Kameleon::DSL::Verify::Presence.new(*args).tap do |presence|
+        presence.conditions.each do |condition|
+          if block = condition.block
+            instance_exec(*condition.params, &block)
+          else
+            page.should send(condition.method, *condition.params)
+          end
+        end
+      end
+    end
+
+    #! hmn - very similar to see
+    def not_see(*args)
+      Kameleon::DSL::Verify::Absence.new(*args).tap do |absence|
+        absence.conditions.each do |condition|
+          if condition.block
+            instance_eval(condition.block)
+          else
+            page.should send(condition.method, *condition.params)
+          end
+        end
+      end
+    end
+
+    def create_session(name = :default)
+      Kameleon::Session.new(name).tap { |ks| act_as(ks.name) }
+    end
+
+    def act_as(name)
+      if block_given?
+        using_session(name) do
+          yield
+        end
+      else
+        Capybara.session_name = name
+      end
+      self
+    end
+
+    def within(*scope, &block)
+      if block_given?
+        super(*parse_selector(scope).selector)
+      else
+        #! we need proxy object to make it working
+        raise 'not impelemented'
+      end
+    end
+
+    def click(*args)
+      Kameleon::DSL::Act::Mouse::Click.new(*args).tap do |click|
+        click.actions.each do |action|
+          if block = action.block
+            instance_exec(*action.params, &block)
+          else
+            page.send(action.method, *action.params)
+          end
+        end
+      end
+    end
+
+    def fill_in(args)
+      Kameleon::DSL::Act::Form.new(args).tap do |form|
+        form.actions.each do |action|
+          if block = action.block
+            instance_exec(*action.params, &block)
+          else
+            page.send(action.method, *action.params)
+          end
+        end
+      end
+    end
+
+    def refresh_page
+      visit current_url
+    end
+
+    private
+
+    def parse_selector(scope)
+      Kameleon::DSL::Context::Scope.new(scope)
+    end
+  end
+end

data/lib/kameleon/dsl/act/form.rb

@@ -0,0 +1,106 @@
+module Kameleon
+  module DSL
+    module Act
+      class Form
+        attr_reader :params
+        attr_reader :actions
+
+        def initialize(params)
+          raise "not supported" unless params.kind_of?(Hash)
+          @params = params
+          @actions = []
+          parse_actions
+        end
+
+        private
+
+        def parse_actions
+          prepare_actions(params)
+        end
+
+        def prepare_actions(param)
+          param.each_pair do |value, identifier|
+            case identifier
+              when Array
+                identifier.each { |identifier| prepare_actions(value => identifier) }
+              else
+                case value
+                  when Fixnum, String
+                    actions << Action.new(:fill_in, identifier, :with => value)
+                  when :check, :choose, :uncheck
+                    actions << Action.new(value, identifier)
+                  when :select, :unselect
+                    actions.concat SelectTag.new(value, identifier).actions
+                  when :attach
+                    actions.concat AttachFileTag.new(identifier).actions
+                  else
+                    raise "not implemented"
+                end
+            end
+          end
+        end
+      end
+
+      class SelectTag
+        attr_reader :actions, :action
+
+        def initialize(action, params)
+          raise "not implemented" unless params.kind_of?(Hash)
+          @action = action
+          @actions = []
+          parse_params(params)
+        end
+
+        def parse_params(params)
+          params.each_pair do |option, id|
+            if option.kind_of?(Array)
+              option.each do |o|
+                parse_params(o => id)
+              end
+            else
+              actions << Action.new(action, option, :from => id)
+            end
+          end
+        end
+      end
+
+      class AttachFileTag
+        attr_reader :actions
+
+        def initialize(params)
+          raise "not implemented" unless params.kind_of?(Hash)
+          @actions = []
+          parse_params(params)
+        end
+
+        private
+
+        def parse_params(params)
+          params.each_pair do |filename, identifier|
+            if identifier.kind_of?(Array)
+              identifier.each do |id|
+                parse_params(filename => id)
+              end
+            else
+              actions << Action.new(:attach_file, identifier, full_path(filename))
+            end
+          end
+        end
+
+        def full_path(filename)
+          if File.file?(filename)
+            filename
+          else
+            prepare_full_path(filename)
+          end
+        end
+
+        def prepare_full_path(filename)
+          File.join(Kameleon::Utils::Configuration.assets_dir, filename)
+        end
+      end
+    end
+  end
+end
+
+#! in future should we check in RackTest - does field is editable (detect readonly, disabled attributes) ?

data/lib/kameleon/dsl/act/mouse.rb

@@ -0,0 +1,59 @@
+module Kameleon
+  module DSL
+    module Act
+      module Mouse
+        class Click
+          attr_reader :params
+          attr_reader :actions
+
+          def initialize(*params)
+            @params = params
+            @actions = []
+            parse_actions
+          end
+
+          private
+
+          def parse_actions
+            prepare_actions(params)
+          end
+
+          def prepare_actions(param)
+            case param
+              when String
+                actions << Action.new(:click_on, param)
+              when Hash
+                param.each_pair do |type, values|
+                  case type
+                    when :non_implemented
+                      raise "not implemented"
+                    else
+                      raise "not implemented"
+                  end
+                end
+              when Array
+                params.each { |parameter| prepare_actions(parameter) }
+              else
+                raise "not implemented"
+            end
+          end
+        end
+      end
+
+      class Action
+        attr_accessor :method, :params, :block
+
+        def initialize(method, *params, &block)
+          @method = method
+          @params = params
+          @block = block
+        end
+      end
+    end
+  end
+end
+
+#! click and dismiss
+#! click and accept
+#! click on image
+#! click on element