cucumber-salad 0.3.0 → 0.3.1

data/lib/cucumber/salad.rb

@@ -1,6 +1,7 @@
 require 'chronic'
 
 require 'cucumber/salad/widget_container'
+require 'cucumber/salad/widget_macros'
 require 'cucumber/salad/conversions'
 require 'cucumber/salad/instance_conversions'
 require 'cucumber/salad/node_text'

data/lib/cucumber/salad/version.rb

@@ -1,5 +1,5 @@
 module Cucumber
   module Salad
-    VERSION = "0.3.0"
+    VERSION = "0.3.1"
   end
 end

data/lib/cucumber/salad/widget_container.rb

@@ -6,7 +6,7 @@ module Cucumber
       end
 
       def widget(name, options = {})
-        widget_class(name).in_node(root, options)
+        widget_class(name).find_in(root, options)
       end
 
       private

data/lib/cucumber/salad/widget_macros.rb

@@ -0,0 +1,84 @@
+module Cucumber
+  module Salad
+    module WidgetMacros
+      # Defines a new action.
+      #
+      # This is a shortcut to help defining a widget and a method that clicks
+      # on that widget. You can then send a widget instance the message given
+      # by +name+.
+      #
+      # @example
+      #   # Consider the widget will encapsulate the following HTML
+      #   #
+      #   # <div id="profile">
+      #   #  <a href="/profiles/1/edit" rel="edit">Edit</a>
+      #   # </div>
+      #   class PirateProfile < Salad::Widget
+      #     root "#profile"
+      #
+      #     # Declare the action
+      #     action :edit, '[rel = edit]'
+      #   end
+      #
+      #   # Click the link
+      #   widget(:pirate_profile).edit
+      #
+      # @param name the name of the action
+      # @param selector the selector for the widget that will be clicked
+      def action(name, selector)
+        widget name, selector
+
+        define_method name do
+          widget(name).click
+
+          self
+        end
+      end
+
+      # Declares a new sub-widget.
+      #
+      # Sub-widgets are accessible inside the container widget using the
+      # +widget+ message.
+      #
+      # @param name the name of the sub-widget
+      # @param selector the sub-widget selector
+      # @param parent [Class] the parent class of the new sub-widget
+      #
+      # @yield A block allowing you to further customize the widget behavior.
+      #
+      # @see #widget
+      def widget(name, selector, parent = Widgets::Widget, &block)
+        type = Class.new(parent) {
+          root selector
+
+          instance_eval(&block) if block
+        }
+
+        const_set(Salad::WidgetName.new(name).to_sym, type)
+      end
+
+      # Creates a delegator for one sub-widget message.
+      #
+      # Since widgets are accessed through {WidgetContainer#widget}, we can't
+      # use {Forwardable} to delegate messages to widgets.
+      #
+      # @param name the name of the receiver sub-widget
+      # @param widget_message the name of the message to be sent to the sub-widget
+      # @param method_name the name of the delegator. If +nil+ the method will
+      #   have the same name as the message it will send.
+      def widget_delegator(name, widget_message, method_name = nil)
+        method_name = method_name || widget_message
+
+        class_eval <<-RUBY
+          def #{method_name}(*args)
+            if args.size == 1
+              widget(:#{name}).#{widget_message} args.first
+            else
+              widget(:#{name}).#{widget_message} *args
+            end
+          end
+        RUBY
+      end
+    end
+  end
+end

data/lib/cucumber/salad/widgets/form.rb

@@ -32,10 +32,6 @@ module Cucumber
           end
         end
 
-        def self.submit(attrs)
-          new.fill_all(attrs).submit
-        end
-
         def self.text_field(name, label = nil)
           define_method "#{name}=" do |val|
             l = label || name_to_locator(name)
@@ -44,42 +40,28 @@ module Cucumber
           end
         end
 
-        def initialize(settings = {})
-          s    = settings.dup
-          data = s.delete(:data) || {}
-
-          super s
-
-          fill_all data
-
-          if block_given?
-            yield self
-
-            submit
-          end
-        end
+        action :submit, '[type = submit]'
 
-        def fill_all(attrs)
-          attrs.each do |k, v|
+        # Sets the given form attributes.
+        #
+        # @param attributes [Hash] the attributes and values we want to set.
+        #
+        # @return the current widget.
+        def set(attributes)
+          attributes.each do |k, v|
             send "#{k}=", v
           end
 
           self
         end
 
-        def submit
-          root.find('[type = "submit"]').click
-
-          self
-        end
-
-        # Submit form with +attrs+.
+        # Submit form with +attributes+.
         #
         # @param attrs [Hash] the form fields and their values
         #
-        # @return self
-        def submit_with(attrs)
-          fill_all attrs
+        # @return the current widget
+        def submit_with(attributes)
+          set attributes
           submit
         end
 

data/lib/cucumber/salad/widgets/widget.rb

@@ -3,43 +3,39 @@ module Cucumber
     module Widgets
       class Widget
         extend Forwardable
+        extend WidgetMacros
 
-        include Salad::Conversions
         include WidgetContainer
 
-        def self.action(name, selector, parent = Widget)
-          widget name, selector, parent
-
-          define_method name do
-            widget(name).click
-          end
-        end
-
         def self.has_instance?(parent_node)
           parent_node.has_selector?(selector)
         end
 
-        def self.in_node(node, options = {})
+        # Finds a single instance of the current widget in +node+.
+        #
+        # @param node the node we want to search in
+        #
+        # @return a new instance of the current widget class.
+        #
+        # @raise [Capybara::ElementNotFoundError] if the widget can't be found
+        def self.find_in(node, options = {})
           new(options.merge(root: node.find(selector)))
         end
 
+        # Sets this widget's default selector.
+        #
+        # @param selector [String] a CSS or XPath query
         def self.root(selector)
           @selector = selector
         end
 
+        # @return The selector specified with +root+.
         def self.selector
           @selector
         end
 
-        def self.widget(name, selector, parent = Widget, &block)
-          type = Class.new(parent) {
-            root selector
-
-            instance_eval(&block) if block
-          }
-
-          const_set(Salad::WidgetName.new(name).to_sym, type)
-        end
+        # @return The root node of the current widget
+        attr_reader :root
 
         def_delegators :root, :click
 
@@ -68,7 +64,7 @@ module Cucumber
 
         private
 
-        attr_accessor :root
+        attr_writer :root
 
         def page
           Capybara.current_session

metadata

@@ -2,14 +2,14 @@
 name: cucumber-salad
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - David Leal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-20 00:00:00.000000000 Z
+date: 2013-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
@@ -111,9 +111,9 @@ files:
 - lib/cucumber/salad/table/void_mapping.rb
 - lib/cucumber/salad/version.rb
 - lib/cucumber/salad/widget_container.rb
+- lib/cucumber/salad/widget_macros.rb
 - lib/cucumber/salad/widget_name.rb
 - lib/cucumber/salad/widgets.rb
-- lib/cucumber/salad/widgets/atom.rb
 - lib/cucumber/salad/widgets/auto_table.rb
 - lib/cucumber/salad/widgets/base_table.rb
 - lib/cucumber/salad/widgets/document.rb
@@ -146,3 +146,4 @@ signing_key:
 specification_version: 3
 summary: A set of helpers to ease writing cucumber features
 test_files: []
+has_rdoc: 

data/lib/cucumber/salad/widgets/atom.rb

@@ -1,19 +0,0 @@
-module Cucumber
-  module Salad
-    module Widgets
-      class Atom < Widget
-        def to_a
-          [to_s]
-        end
-
-        def ==(other)
-          to_s.downcase == other.to_s.downcase
-        end
-
-        def to_s
-          node_text(root)
-        end
-      end
-    end
-  end
-end