cucumber-salad 0.2.2 → 0.3.0

data/lib/cucumber/salad/boot.rb

@@ -0,0 +1,9 @@
+require 'cucumber/salad'
+
+World(Cucumber::Salad::DSL)
+
+module Salad
+  include Cucumber::Salad::Widgets
+
+  DSL = Cucumber::Salad::DSL
+end

data/lib/cucumber/salad/dsl.rb

@@ -0,0 +1,36 @@
+module Cucumber
+  module Salad
+    module DSL
+      attr_writer :widget_lookup_scope
+
+      # @return [Widgets::Document] the current document with the class of the
+      #   current object set as the widget lookup scope.
+      def document
+        Widgets::Document.new(widget_lookup_scope: widget_lookup_scope)
+      end
+
+      # @return [Boolean] Whether one or more widgets exist in the current
+      #   document.
+      def has_widget?(name)
+        document.has_widget?(name)
+      end
+
+      # Returns a widget instance for the given name.
+      #
+      # @param name [String, Symbol]
+      def widget(name, options = {})
+        document.widget(name, options)
+      end
+
+      def widget_lookup_scope
+        @widget_lookup_scope ||= default_widget_lookup_scope
+      end
+
+      private
+
+      def default_widget_lookup_scope
+        Module === self ? self : self.class
+      end
+    end
+  end
+end

data/lib/cucumber/salad/version.rb

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

data/lib/cucumber/salad/widget_container.rb

@@ -0,0 +1,25 @@
+module Cucumber
+  module Salad
+    module WidgetContainer
+      def has_widget?(name)
+        widget_class(name).has_instance?(root)
+      end
+
+      def widget(name, options = {})
+        widget_class(name).in_node(root, options)
+      end
+
+      private
+
+      attr_writer :widget_lookup_scope
+
+      def widget_class(name)
+        WidgetName.new(name).to_class(widget_lookup_scope)
+      end
+
+      def widget_lookup_scope
+        @widget_lookup_scope || self.class
+      end
+    end
+  end
+end

data/lib/cucumber/salad/widget_name.rb

@@ -0,0 +1,59 @@
+module Cucumber
+  module Salad
+    # The name of a widget in a format-independent representation.
+    class WidgetName < String
+      CAMEL_CASE_FORMAT = /\A([A-Z][a-z]*)+\Z/
+      SNAKE_CASE_FORMAT = /\A\w+\Z/
+
+      # Constructs the widget name.
+      #
+      # @param name [String, Symbol] the name of the widget in primitive form
+      def initialize(name)
+        @name      = name
+        @canonical = canonical(@name)
+      end
+
+      # Returns the class for this widget name, in the given scope.
+      def to_class(scope = Object)
+        const = scope.const_get(@canonical)
+
+        raise TypeError, "`#{@canonical}' is not a widget in this scope" \
+          unless const < Widgets::Widget
+
+        const
+      rescue NameError
+        raise UnknownWidgetError,
+              "couldn't find `#{@name}' widget in this scope"
+      end
+
+      def to_sym
+        @canonical.to_sym
+      end
+
+      private
+
+      def canonical(name)
+        str = name.to_s
+
+        case str
+        when SNAKE_CASE_FORMAT
+          camel_case_from_snake_case(str)
+        when CAMEL_CASE_FORMAT
+          str
+        else
+          raise ArgumentError, "can't convert `#{str.inspect}' to canonical form"
+        end
+      end
+
+      def camel_case_from_snake_case(name)
+        capitalize_word = ->(word) { word[0].upcase + word[1..-1] }
+        word_separator  = '_'
+
+        name
+          .split(word_separator)
+          .map(&capitalize_word)
+          .join
+      end
+    end
+  end
+end

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

@@ -2,6 +2,13 @@ module Cucumber
   module Salad
     module Widgets
       class AutoTable < BaseTable
+
+        # don't include footer in to_table, because footer column configuration is very
+        # often different from the headers & values.
+        def footers
+          @footers ||= root.all(footer_selector).map { |n| node_text(n) }
+        end
+
         protected
 
         def ensure_table_loaded
@@ -35,6 +42,10 @@ module Cucumber
           @headers ||= root.all(header_selector).map { |n| node_text(n).downcase }
         end
 
+        def footer_selector
+          'tfoot td'
+        end
+
         def values
           @values ||= data_rows.map(&:values)
         end

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

@@ -0,0 +1,18 @@
+module Cucumber
+  module Salad
+    module Widgets
+      class Document
+        include WidgetContainer
+
+        def initialize(options)
+          self.widget_lookup_scope =
+            options.delete(:widget_lookup_scope) or raise "No scope given"
+        end
+
+        def root
+          Capybara.current_session
+        end
+      end
+    end
+  end
+end

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

@@ -20,7 +20,7 @@ module Cucumber
           end
         end
 
-        def self.select_box(name, *args)
+        def self.select(name, *args)
           opts   = args.extract_options!
           label, = args
 
@@ -36,7 +36,7 @@ module Cucumber
           new.fill_all(attrs).submit
         end
 
-        def self.text(name, label = nil)
+        def self.text_field(name, label = nil)
           define_method "#{name}=" do |val|
             l = label || name_to_locator(name)
 
@@ -73,6 +73,16 @@ module Cucumber
           self
         end
 
+        # Submit form with +attrs+.
+        #
+        # @param attrs [Hash] the form fields and their values
+        #
+        # @return self
+        def submit_with(attrs)
+          fill_all attrs
+          submit
+        end
+
         private
 
         def label(name)

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

@@ -2,11 +2,11 @@ module Cucumber
   module Salad
     module Widgets
       class List < Widget
-        DEFAULT_TYPE = Atom
+        DEFAULT_TYPE = Widget
 
         include Enumerable
 
-        def_delegators :items, :size, :include?, :each, :empty?, :first
+        def_delegators :items, :size, :include?, :each, :empty?, :first, :last
 
         def self.item(selector, type = DEFAULT_TYPE, &item_for)
           define_method :item_selector do

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

@@ -5,36 +5,46 @@ module Cucumber
         extend Forwardable
 
         include Salad::Conversions
+        include WidgetContainer
 
-        def self.action(name, selector, options = {})
-          wname = "#{name}_action"
-
-          widget wname, selector, type: options[:type] || Action
+        def self.action(name, selector, parent = Widget)
+          widget name, selector, parent
 
           define_method name do
-            send(wname).click
+            widget(name).click
           end
         end
 
+        def self.has_instance?(parent_node)
+          parent_node.has_selector?(selector)
+        end
+
+        def self.in_node(node, options = {})
+          new(options.merge(root: node.find(selector)))
+        end
+
         def self.root(selector)
-          define_method :default_root_selector do
-            selector
-          end
+          @selector = selector
+        end
 
-          private :default_root_selector
+        def self.selector
+          @selector
         end
 
-        def self.widget(name, selector, options = {}, &block)
-          type = options.fetch(:type, Atom)
-          t    = block_given? ? Class.new(type, &block) : type
+        def self.widget(name, selector, parent = Widget, &block)
+          type = Class.new(parent) {
+            root selector
 
-          define_method name do
-            t.new(root: root.find(selector))
-          end
+            instance_eval(&block) if block
+          }
+
+          const_set(Salad::WidgetName.new(name).to_sym, type)
         end
 
+        def_delegators :root, :click
+
         def initialize(settings = {})
-          self.root = settings[:root] if settings[:root]
+          self.root = settings.fetch(:root)
         end
 
         def inspect
@@ -44,6 +54,12 @@ module Cucumber
            Nokogiri::XML(xml, &:noblanks).to_xhtml
         end
 
+        def to_s
+          node_text(root)
+        end
+
+        alias_method :w, :widget
+
         protected
 
         def node_text(node)
@@ -52,37 +68,11 @@ module Cucumber
 
         private
 
-        attr_writer :root_selector
-
-        def default_root_selector
-          raise NotImplementedError,
-                "#{self.class.name}: default root selector undefined"
-        end
+        attr_accessor :root
 
         def page
           Capybara.current_session
         end
-
-        def root
-          @root || page.find(root_selector)
-        end
-
-        def root=(selector_or_node)
-          case selector_or_node
-          when String
-            self.root_selector = selector_or_node
-          when Capybara::Node::Element, Capybara::Node::Simple
-            @root = selector_or_node
-          else
-            msg = "can't convert #{selector_or_node.inspect} to root node"
-
-            raise ArgumentError, msg
-          end
-        end
-
-        def root_selector
-          @root_selector || default_root_selector
-        end
       end
     end
   end

data/lib/cucumber/salad/widgets.rb

@@ -1,6 +1,4 @@
 require 'cucumber/salad/widgets/widget'
-require 'cucumber/salad/widgets/atom'
-require 'cucumber/salad/widgets/action'
 require 'cucumber/salad/widgets/list'
 require 'cucumber/salad/widgets/base_table'
 require 'cucumber/salad/widgets/auto_table'

data/lib/cucumber/salad.rb

@@ -1,11 +1,17 @@
 require 'chronic'
 
+require 'cucumber/salad/widget_container'
 require 'cucumber/salad/conversions'
 require 'cucumber/salad/instance_conversions'
 require 'cucumber/salad/node_text'
+require 'cucumber/salad/widget_name'
 require 'cucumber/salad/widgets'
 require 'cucumber/salad/table'
 require 'cucumber/salad/table/mapping'
 require 'cucumber/salad/table/void_mapping'
 require 'cucumber/salad/table/transformations'
 require 'cucumber/salad/table/cell_text'
+require 'cucumber/salad/widgets/document'
+require 'cucumber/salad/dsl'
+
+class UnknownWidgetError < StandardError; end

metadata

@@ -2,14 +2,14 @@
 name: cucumber-salad
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - David Leal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-27 00:00:00.000000000 Z
+date: 2013-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
@@ -75,6 +75,22 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.11.0
     none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  name: sinatra
+  type: :development
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
 description: See https://github.com/mojotech/cucumber-salad/README.md
 email:
 - dleal@mojotech.com
@@ -83,7 +99,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/cucumber/salad.rb
+- lib/cucumber/salad/boot.rb
 - lib/cucumber/salad/conversions.rb
+- lib/cucumber/salad/dsl.rb
 - lib/cucumber/salad/instance_conversions.rb
 - lib/cucumber/salad/node_text.rb
 - lib/cucumber/salad/table.rb
@@ -92,11 +110,13 @@ files:
 - lib/cucumber/salad/table/transformations.rb
 - lib/cucumber/salad/table/void_mapping.rb
 - lib/cucumber/salad/version.rb
+- lib/cucumber/salad/widget_container.rb
+- lib/cucumber/salad/widget_name.rb
 - lib/cucumber/salad/widgets.rb
-- lib/cucumber/salad/widgets/action.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
 - lib/cucumber/salad/widgets/form.rb
 - lib/cucumber/salad/widgets/list.rb
 - lib/cucumber/salad/widgets/table.rb

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

@@ -1,9 +0,0 @@
-module Cucumber
-  module Salad
-    module Widgets
-      class Action < Atom
-        def_delegators :root, :click
-      end
-    end
-  end
-end