dill 0.5.2 → 0.6.0

data/lib/dill.rb

@@ -2,28 +2,16 @@ require 'chronic'
 require 'nokogiri'
 require 'capybara'
 
-require 'dill/checkpoint'
-require 'dill/widget_class'
-require 'dill/widget_checkpoint'
-require 'dill/widget_container'
 require 'dill/conversions'
 require 'dill/instance_conversions'
-require 'dill/node_text'
-require 'dill/widget_name'
-require 'dill/widget'
-require 'dill/list_item'
-require 'dill/list'
-require 'dill/base_table'
-require 'dill/auto_table'
-require 'dill/table'
-require 'dill/field_group'
-require 'dill/form'
-require 'dill/document'
+require 'dill/checkpoint'
+require 'dill/widgets'
 require 'dill/text_table'
 require 'dill/text_table/mapping'
 require 'dill/text_table/void_mapping'
 require 'dill/text_table/transformations'
 require 'dill/text_table/cell_text'
+require 'dill/capybara'
 require 'dill/dsl'
 
 module Dill

data/lib/dill/capybara.rb

@@ -0,0 +1,7 @@
+Capybara.configure do |config|
+  config.match = :one
+  config.exact = true
+  config.exact_options = true
+  config.ignore_hidden_elements = true
+  config.visible_text_only = true
+end

data/lib/dill/checkpoint.rb

@@ -6,14 +6,54 @@ module Dill
   #   which inspired this class.
   class Checkpoint
     class ConditionNotMet < StandardError; end
-    class TimeFrozen < StandardError; end
 
-    # @return the configured wait time, in seconds.
-    attr_reader :wait_time
+    class Timer
+      class Frozen < StandardError; end
+
+      def initialize(duration)
+        @duration = duration
+      end
+
+      attr_reader :duration
+
+      def expired?
+        duration < elapsed
+      end
+
+      def elapsed
+        now - start_time
+      end
+
+      def start
+        @start_time = now
+      end
+
+      def tick
+        sleep tick_duration
+
+        raise Frozen, 'time appears to be frozen' if frozen?
+      end
+
+      protected
+
+      def now
+        Time.now
+      end
+
+      attr_reader :start_time
+
+      def frozen?
+        now == start_time
+      end
+
+      def tick_duration
+        0.05
+      end
+    end
 
     # Shortcut for instance level wait_for.
     def self.wait_for(wait_time = Capybara.default_wait_time, &block)
-      new(wait_time).wait_for(&block)
+      new(wait_time).call(&block)
     end
 
     # Initializes a new Checkpoint.
@@ -21,7 +61,7 @@ module Dill
     # @param wait_time how long this checkpoint will wait for its conditions to
     #   be met, in seconds.
     def initialize(wait_time = Capybara.default_wait_time)
-      @wait_time = wait_time
+      @timer = Timer.new(wait_time)
     end
 
     # Executes +block+ repeatedly until it returns a "truthy" value or
@@ -35,48 +75,26 @@ module Dill
     # raises a Dill::Checkpoint::ConditionNotMet error.
     #
     # Returns whatever value is returned by the block.
-    def wait_for(&condition)
-      start
+    def call(&condition)
+      timer.start
 
       begin
         yield or raise ConditionNotMet
       rescue *rescuable_errors
-        raise if expired?
-
-        wait
+        raise if timer.expired?
 
-        raise TimeFrozen, 'time appears to be frozen' if time_frozen?
+        timer.tick
 
         retry
       end
     end
 
+    protected
+
     def rescuable_errors
       [StandardError]
     end
 
-    private
-
-    attr_reader :start_time
-
-    def expired?
-      remaining_time > wait_time
-    end
-
-    def remaining_time
-      Time.now - start_time
-    end
-
-    def start
-      @start_time = Time.now
-    end
-
-    def wait
-      sleep 0.05
-    end
-
-    def time_frozen?
-      Time.now == start_time
-    end
+    attr_reader :timer
   end
 end

data/lib/dill/conversions.rb

@@ -1,5 +1,7 @@
 module Dill
   module Conversions
+    extend self
+
     def Boolean(val)
       case val
       when 'yes', 'true', true

data/lib/dill/dsl.rb

@@ -5,26 +5,36 @@ module Dill
     # @return [Document] the current document with the class of the
     #   current object set as the widget lookup scope.
     def document
-      Document.new(widget_lookup_scope: widget_lookup_scope)
+      Document.new(widget_lookup_scope)
     end
 
     # @return [Boolean] Whether one or more widgets exist in the current
     #   document.
-    def has_widget?(name)
-      document.has_widget?(name)
+    def has_widget?(name, *args)
+      document.has_widget?(name, *args)
+    end
+
+    def value(name, *args)
+      widget(name, *args).value
     end
 
     # Returns a widget instance for the given name.
     #
     # @param name [String, Symbol]
-    def widget(name)
-      document.widget(name)
+    def widget(name, *args)
+      document.widget(name, *args)
     end
 
     def widget_lookup_scope
       @widget_lookup_scope ||= default_widget_lookup_scope
     end
 
+    # re-run one or more assertions until either they all pass,
+    # or Dill times out, which will result in a test failure.
+    def eventually(wait_time = Capybara.default_wait_time, &block)
+      Checkpoint.wait_for wait_time, &block
+    end
+
     private
 
     def default_widget_lookup_scope

data/lib/dill/version.rb

@@ -1,3 +1,3 @@
 module Dill
-  VERSION = "0.5.2"
+  VERSION = '0.6.0'
 end

data/lib/dill/widgets.rb

@@ -0,0 +1,56 @@
+# This file describes the organization of the major Widget API components.
+#
+# === Parts
+#
+# Widget parts encapsulate the set of behaviours that constitute a widget.
+module Dill
+  module Constructors
+    def Widget(*selector, &block)
+      WidgetClass.new(selector.flatten, &block)
+    end
+
+    alias_method :String, :Widget
+
+    def Integer(*selector)
+      Widget(selector) do
+        def value
+          Integer(text)
+        end
+      end
+    end
+
+    require 'bigdecimal'
+
+    def Decimal(*selector)
+      Widget(selector) do
+        def value
+          # ensure we can convert to float first
+          Float(text) && BigDecimal.new(text)
+        end
+      end
+    end
+  end
+
+  extend Constructors
+end
+
+module Dill::WidgetParts; end
+
+require 'dill/widgets/parts/struct'
+require 'dill/widgets/parts/container'
+
+require 'dill/widgets/widget_class'
+require 'dill/widgets/widget_name'
+require 'dill/widgets/widget'
+require 'dill/widgets/list_item'
+require 'dill/widgets/list'
+require 'dill/widgets/base_table'
+require 'dill/widgets/auto_table'
+require 'dill/widgets/table'
+require 'dill/widgets/field'
+require 'dill/widgets/check_box'
+require 'dill/widgets/select'
+require 'dill/widgets/text_field'
+require 'dill/widgets/field_group'
+require 'dill/widgets/form'
+require 'dill/widgets/document'

data/lib/dill/{auto_table.rb → widgets/auto_table.rb}

@@ -4,7 +4,7 @@ module Dill
     # 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) }
+      @footers ||= root.all(footer_selector).map { |n| Widget.new(n).text }
     end
 
     protected
@@ -37,7 +37,9 @@ module Dill
     end
 
     def headers
-      @headers ||= root.all(header_selector).map { |n| node_text(n).downcase }
+      @headers ||= root.
+                     all(header_selector).
+        map { |n| Widget.new(n).text.downcase }
     end
 
     def footer_selector
@@ -66,7 +68,7 @@ module Dill
       attr_accessor :cell_selector
 
       def node_text(node)
-        NodeText.new(node)
+        node.text.strip
       end
     end
   end

data/lib/dill/widgets/check_box.rb

@@ -0,0 +1,26 @@
+module Dill
+  # A check box.
+  class CheckBox < Field
+    # @!method set(value)
+    #   Checks or unchecks the current checkbox.
+    #
+    #   @param value [Boolean] +true+ to check the checkbox, +false+
+    #     otherwise.
+    def_delegator :root, :set
+
+    # @return [Boolean] +true+ if the checkbox is checked, +false+
+    #   otherwise.
+    def get
+      !! root.checked?
+    end
+
+    def to_cell
+      to_s
+    end
+
+    # @return +"yes"+ if the checkbox is checked, +"no"+ otherwise.
+    def to_s
+      get ? 'yes' : 'no'
+    end
+  end
+end

data/lib/dill/widgets/document.rb

@@ -0,0 +1,13 @@
+module Dill
+  class Document
+    include WidgetParts::Container
+
+    def initialize(widget_lookup_scope)
+      self.widget_lookup_scope = widget_lookup_scope or raise 'No scope given'
+    end
+
+    def root
+      Capybara.current_session
+    end
+  end
+end

data/lib/dill/widgets/field.rb

@@ -0,0 +1,26 @@
+module Dill
+  # A form field.
+  class Field < Widget
+    def self.find_in(parent)
+      new { parent.root.find_field(*selector) }
+    end
+
+    def self.present_in?(parent)
+      parent.root.has_field?(*selector)
+    end
+
+    # @return This field's value.
+    #
+    # Override this to get the actual value.
+    def get
+      raise NotImplementedError
+    end
+
+    # Sets the field value.
+    #
+    # Override this to set the value.
+    def set(value)
+      raise NotImplementedError
+    end
+  end
+end

data/lib/dill/{field_group.rb → widgets/field_group.rb}

@@ -241,91 +241,5 @@ module Dill
 
       [headers, body]
     end
-
-    # A form field.
-    class Field < Widget
-      def self.find_in(parent)
-        new(parent.find_field(*selector))
-      end
-
-      def self.present_in?(parent)
-        parent.has_field?(*selector)
-      end
-
-      # @return This field's value.
-      #
-      # Override this to get the actual value.
-      def get
-        raise NotImplementedError
-      end
-
-      # Sets the field value.
-      #
-      # Override this to set the value.
-      def set(value)
-        raise NotImplementedError
-      end
-    end
-
-    # A check box.
-    class CheckBox < Field
-      # @!method set(value)
-      #   Checks or unchecks the current checkbox.
-      #
-      #   @param value [Boolean] +true+ to check the checkbox, +false+
-      #     otherwise.
-      def_delegator :root, :set
-
-      # @return [Boolean] +true+ if the checkbox is checked, +false+
-      #   otherwise.
-      def get
-        !! root.checked?
-      end
-
-      # @return +"yes"+ if the checkbox is checked, +"no"+ otherwise.
-      def to_s
-        get ? 'yes' : 'no'
-      end
-    end
-
-    # A select.
-    class Select < Field
-      # @return [String] The text of the selected option.
-      def get
-        option = root.find('[selected]') rescue nil
-
-        option && option.text
-      end
-
-      # Selects the given option.
-      #
-      # @param option [String] The text of the option to select.
-      def set(option)
-        root.find('option', text: option).select_option
-      end
-
-      # @!method to_s
-      #   @return the text of the selected option, or the empty string if
-      #     no option is selected.
-      def_delegator :get, :to_s
-    end
-
-    # A text field.
-    class TextField < Field
-      # @!method get
-      #   @return The text field value.
-      def_delegator :root, :value, :get
-
-      # @!method set(value)
-      #   Sets the text field value.
-      #
-      #   @param value [String] the value to set.
-      def_delegator :root, :set
-
-      # @!method to_s
-      #   @return the text field value, or the empty string if the field is
-      #     empty.
-      def_delegator :get, :to_s
-    end
   end
 end