capybara-ui 0.10.0 → 1.0.0

data/lib/capybara/ui/widgets/widget/node_filter.rb

@@ -0,0 +1,50 @@
+module Capybara
+  module UI
+    class Widget
+      class NodeFilter
+        attr_reader :selector
+
+        def initialize(*selector)
+          @selector = selector.flatten
+        end
+
+        def node(parent_widget, *args)
+          parent_widget.root.find(*capybara_selector(*args))
+        end
+
+        def node?(parent_widget, *args)
+          parent_widget.root.has_selector?(*capybara_selector(*args))
+        end
+
+        def nodeless?(parent_widget, *args)
+          parent_widget.root.has_no_selector?(*capybara_selector(*args))
+        end
+
+        def nodes(parent_widget, *args)
+          parent_widget.root.all(*capybara_selector(*args))
+        end
+
+        private
+
+        def capybara_selector(*args)
+          # TODO detect signature errors (e.g., passing a different arity than the
+          # one required by the selector proc, etc)
+          selector = if @selector.first.respond_to?(:call)
+                       @selector.first.call(*args)
+                     else
+                       @selector
+                     end
+          selector = Array(selector).flatten
+
+          defaults = {:wait => 0}
+
+          if Hash === selector.last
+            selector + [defaults.merge(selector.pop)]
+          else
+            selector + [defaults]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/capybara/ui/widgets/widget_class.rb

@@ -0,0 +1,13 @@
+module Capybara
+  module UI
+    module WidgetClass
+      def self.new(selector, parent = Widget, &extensions)
+        klass = Class.new(parent) { root selector }
+
+        klass.class_eval(&extensions) if block_given?
+
+        klass
+      end
+    end
+  end
+end

data/lib/capybara/ui/widgets/widget_name.rb

@@ -0,0 +1,58 @@
+module Capybara
+  module UI
+    # 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 < Widget
+
+        const
+      rescue NameError
+        raise Missing, "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, "`#{str.inspect}' is an unrecognized format. Try snake case or camel case."
+        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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capybara-ui
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 1.0.0
 platform: ruby
 authors:
 - David Leal
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-16 00:00:00.000000000 Z
+date: 2016-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chronic
@@ -165,7 +165,11 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: See https://github.com/mojotech/capybara-ui/README.md
+description: Capybara-UI (formerly called Dill) is a Capybara abstraction that makes
+  it easy to define reuseable DOM "widgets", aka page objects, and introduces the
+  concept of "roles" to allow you to easily organize your testing methods and widgets.
+  Capybara-UI also introduces helpers and syntactic sugar to make your testing even
+  easier.
 email:
 - dleal@mojotech.com
 - ags@mojotech.com
@@ -173,46 +177,46 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/capybara-ui.rb
-- lib/capybara-ui/assertions.rb
-- lib/capybara-ui/capybara.rb
-- lib/capybara-ui/checkpoint.rb
-- lib/capybara-ui/conversions.rb
-- lib/capybara-ui/cucumber.rb
-- lib/capybara-ui/dsl.rb
-- lib/capybara-ui/instance_conversions.rb
-- lib/capybara-ui/matchers.rb
-- lib/capybara-ui/optional_dependencies.rb
-- lib/capybara-ui/rails.rb
-- lib/capybara-ui/rails/role.rb
-- lib/capybara-ui/role.rb
-- lib/capybara-ui/text_table.rb
-- lib/capybara-ui/text_table/cell_text.rb
-- lib/capybara-ui/text_table/mapping.rb
-- lib/capybara-ui/text_table/transformations.rb
-- lib/capybara-ui/text_table/void_mapping.rb
-- lib/capybara-ui/version.rb
-- lib/capybara-ui/widgets.rb
-- lib/capybara-ui/widgets/check_box.rb
-- lib/capybara-ui/widgets/cucumber_methods.rb
-- lib/capybara-ui/widgets/document.rb
-- lib/capybara-ui/widgets/dsl.rb
-- lib/capybara-ui/widgets/field.rb
-- lib/capybara-ui/widgets/field_group.rb
-- lib/capybara-ui/widgets/form.rb
-- lib/capybara-ui/widgets/list.rb
-- lib/capybara-ui/widgets/list_item.rb
-- lib/capybara-ui/widgets/parts/container.rb
-- lib/capybara-ui/widgets/parts/struct.rb
-- lib/capybara-ui/widgets/radio_button.rb
-- lib/capybara-ui/widgets/select.rb
-- lib/capybara-ui/widgets/string_value.rb
-- lib/capybara-ui/widgets/table.rb
-- lib/capybara-ui/widgets/text_field.rb
-- lib/capybara-ui/widgets/widget.rb
-- lib/capybara-ui/widgets/widget/node_filter.rb
-- lib/capybara-ui/widgets/widget_class.rb
-- lib/capybara-ui/widgets/widget_name.rb
+- lib/capybara/ui.rb
+- lib/capybara/ui/assertions.rb
+- lib/capybara/ui/capybara.rb
+- lib/capybara/ui/checkpoint.rb
+- lib/capybara/ui/conversions.rb
+- lib/capybara/ui/cucumber.rb
+- lib/capybara/ui/dsl.rb
+- lib/capybara/ui/instance_conversions.rb
+- lib/capybara/ui/matchers.rb
+- lib/capybara/ui/optional_dependencies.rb
+- lib/capybara/ui/rails.rb
+- lib/capybara/ui/rails/role.rb
+- lib/capybara/ui/role.rb
+- lib/capybara/ui/text_table.rb
+- lib/capybara/ui/text_table/cell_text.rb
+- lib/capybara/ui/text_table/mapping.rb
+- lib/capybara/ui/text_table/transformations.rb
+- lib/capybara/ui/text_table/void_mapping.rb
+- lib/capybara/ui/version.rb
+- lib/capybara/ui/widgets.rb
+- lib/capybara/ui/widgets/check_box.rb
+- lib/capybara/ui/widgets/cucumber_methods.rb
+- lib/capybara/ui/widgets/document.rb
+- lib/capybara/ui/widgets/dsl.rb
+- lib/capybara/ui/widgets/field.rb
+- lib/capybara/ui/widgets/field_group.rb
+- lib/capybara/ui/widgets/form.rb
+- lib/capybara/ui/widgets/list.rb
+- lib/capybara/ui/widgets/list_item.rb
+- lib/capybara/ui/widgets/parts/container.rb
+- lib/capybara/ui/widgets/parts/struct.rb
+- lib/capybara/ui/widgets/radio_button.rb
+- lib/capybara/ui/widgets/select.rb
+- lib/capybara/ui/widgets/string_value.rb
+- lib/capybara/ui/widgets/table.rb
+- lib/capybara/ui/widgets/text_field.rb
+- lib/capybara/ui/widgets/widget.rb
+- lib/capybara/ui/widgets/widget/node_filter.rb
+- lib/capybara/ui/widgets/widget_class.rb
+- lib/capybara/ui/widgets/widget_name.rb
 homepage: https://github.com/mojotech/capybara-ui
 licenses:
 - MIT

data/lib/capybara-ui.rb

@@ -1,31 +0,0 @@
-require 'chronic'
-require 'nokogiri'
-require 'capybara'
-
-require 'capybara-ui/optional_dependencies'
-require 'capybara-ui/conversions'
-require 'capybara-ui/instance_conversions'
-require 'capybara-ui/checkpoint'
-require 'capybara-ui/widgets'
-require 'capybara-ui/text_table'
-require 'capybara-ui/text_table/mapping'
-require 'capybara-ui/text_table/void_mapping'
-require 'capybara-ui/text_table/transformations'
-require 'capybara-ui/text_table/cell_text'
-require 'capybara-ui/capybara'
-require 'capybara-ui/dsl'
-
-module CapybaraUI
-  # An exception that signals that something is missing.
-  class Missing < StandardError; end
-  class MissingWidget < StandardError; end
-  class AmbiguousWidget < StandardError; end
-  class InvalidOption < StandardError; end
-  class InvalidRadioButton < StandardError; end
-
-  def deprecate(method, alternate_method, once=false)
-    @deprecation_notified ||= {}
-    warn "DEPRECATED: ##{method} is deprecated, please use ##{alternate_method} instead" unless once and @deprecation_notified[method]
-    @deprecation_notified[method] = true
-  end
-end

data/lib/capybara-ui/assertions.rb

@@ -1,19 +0,0 @@
-module CapybaraUI
-  module Assertions
-    def assert_visible(role, widget_name, *args)
-      eventually do
-        assert role.see?(widget_name, *args)
-
-        true
-      end
-    end
-
-    def assert_not_visible(role, widget_name, *args)
-      eventually do
-        refute role.see?(widget_name, *args)
-
-        true
-      end
-    end
-  end
-end

data/lib/capybara-ui/checkpoint.rb

@@ -1,111 +0,0 @@
-module CapybaraUI
-  # A point in time where some condition, or some set of conditions, should be
-  # verified.
-  #
-  # @see http://rubydoc.info/github/jnicklas/capybara/master/Capybara/Node/Base#synchronize-instance_method,
-  #   which inspired this class.
-  class Checkpoint
-    class ConditionNotMet < StandardError; end
-
-    class << self
-      attr_accessor :rescuable_errors
-    end
-
-    self.rescuable_errors = [StandardError]
-
-    if defined?(RSpec)
-      require 'rspec/expectations'
-      self.rescuable_errors << RSpec::Expectations::ExpectationNotMetError
-    end
-
-    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_max_wait_time, &block)
-      new(wait_time).call(&block)
-    end
-
-    # Initializes a new Checkpoint.
-    #
-    # @param wait_time how long this checkpoint will wait for its conditions to
-    #   be met, in seconds.
-    def initialize(wait_time = Capybara.default_max_wait_time)
-      @timer = Timer.new(wait_time)
-    end
-
-    # Executes +block+ repeatedly until it returns a "truthy" value or
-    # +wait_time+ expires.
-    #
-    # Swallows any StandardError or StandardError descendent until +wait_time+
-    # expires. If an exception is raised and the time has expired, that
-    # exception will be raised again.
-    #
-    # If the block does not return a "truthy" value until +wait_time+ expires,
-    # raises a CapybaraUI::Checkpoint::ConditionNotMet error.
-    #
-    # Returns whatever value is returned by the block.
-    def call(&condition)
-      timer.start
-
-      begin
-        yield or raise ConditionNotMet
-      rescue *rescuable_errors
-        raise if timer.expired?
-
-        timer.tick
-
-        retry
-      end
-    end
-
-    protected
-
-    def rescuable_errors
-      self.class.rescuable_errors
-    end
-
-    attr_reader :timer
-  end
-end

data/lib/capybara-ui/conversions.rb

@@ -1,31 +0,0 @@
-module CapybaraUI
-  module Conversions
-    extend self
-
-    def Boolean(val)
-      case val
-      when 'yes', 'true', true
-        true
-      when 'no', 'false', false, nil, ''
-        false
-      else
-        raise ArgumentError, "can't convert #{val.inspect} to boolean"
-      end
-    end
-
-    def List(valstr, &block)
-      vs = valstr.strip.split(/\s*,\s*/)
-
-      block ? vs.map(&block) : vs
-    end
-
-    def Timeish(val)
-      raise ArgumentError, "can't convert nil to Timeish" if val.nil?
-
-      return val if Date === val || Time === val || DateTime === val
-
-      Chronic.parse(val) or
-        raise ArgumentError, "can't parse #{val.inspect} to Timeish"
-    end
-  end
-end

data/lib/capybara-ui/cucumber.rb

@@ -1,5 +0,0 @@
-require 'capybara/cucumber'
-require 'capybara-ui/rails'
-require 'capybara-ui/matchers'
-
-World(CapybaraUI::DSL)