tapestry 0.1.0 → 0.2.0

data/lib/tapestry/ready.rb

@@ -0,0 +1,93 @@
+require "tapestry/situation"
+
+module Tapestry
+  module Ready
+    include Situation
+
+    # The ReadyAttributes contains methods that can be called directly on the
+    # interface class definition. These are very much like the attributes
+    # that are used for defining aspects of the pages, such as `url_is` or
+    # `title_is`. These attributes are included separately so as to maintain
+    # more modularity.
+    module ReadyAttributes
+      # This method will provide a list of the ready_validations that have
+      # been defined. This list will contain the list in the order that the
+      # validations were defined in.
+      def ready_validations
+        if superclass.respond_to?(:ready_validations)
+          superclass.ready_validations + _ready_validations
+        else
+          _ready_validations
+        end
+      end
+
+      # When this attribute method is specified on an interface, it will
+      # append the validation provided by the block.
+      def page_ready(&block)
+        _ready_validations << block
+      end
+
+      alias page_ready_when page_ready
+
+      private
+
+      def _ready_validations
+        @_ready_validations ||= []
+      end
+    end
+
+    def self.included(caller)
+      caller.extend(ReadyAttributes)
+    end
+
+    # If a ready validation fails, the message reported by that failure will
+    # be captured in the `ready_error` accessor.
+    attr_accessor :ready, :ready_error
+
+    # The `when_ready` method is called on an instance of an interface. This
+    # executes the provided validation block after the page has been loaded.
+    # The Ready object instance is yielded into the block.
+    #
+    # Calls to the `ready?` method use a poor-man's cache approach. The idea
+    # here being that when a page has confirmed that it is ready, meaning that
+    # no ready validations have failed, that information is stored so that any
+    # subsequent calls to `ready?` do not query the ready validations again.
+    def when_ready(&_block)
+      already_marked_ready = ready
+
+      no_ready_check_possible unless block_given?
+
+      self.ready = ready?
+      not_ready_validation(ready_error || 'NO REASON PROVIDED') unless ready
+      yield self
+    ensure
+      self.ready = already_marked_ready
+    end
+
+    # The `ready?` method is used to check if the page has been loaded
+    # successfully, which means that none of the ready validations have
+    # indicated failure.
+    #
+    # When `ready?` is called, the blocks that were stored in the above
+    # `ready_validations` array are instance evaluated against the current
+    # page instance.
+    def ready?
+      self.ready_error = nil
+      return true if ready
+      ready_validations_pass?
+    end
+
+    private
+
+    # This method checks if the ready validations that have been specified
+    # have passed. If any ready validation fails, no matter if others have
+    # succeeded, this method immediately returns false.
+    def ready_validations_pass?
+      self.class.ready_validations.all? do |validation|
+        passed, message = instance_eval(&validation)
+        self.ready_error = message if message && !passed
+        passed
+      end
+    end
+  end
+end

data/lib/tapestry/situation.rb

@@ -0,0 +1,77 @@
+require "tapestry/errors"
+
+module Tapestry
+  module Situation
+    private
+
+    def url_is_empty
+      puts "PROBLEM: url_is attribute empty.\n" \
+      "The url_is attribute is empty on the definition " \
+      "'#{retrieve_class(caller)}'.\n\n"
+      raise Tapestry::Errors::NoUrlForDefinition
+    end
+
+    def no_url_provided
+      puts "PROBLEM: no url provided.\n" \
+      "You called a '#{retrieve_method(caller)}' action but the " \
+      "definition '#{self.class}' does not have a url_is attribute.\n" \
+      "Either provide the url_is attribute or pass the url as an " \
+      "argument to the visit call.\n\n"
+      raise Tapestry::Errors::NoUrlForDefinition
+    end
+
+    def url_match_is_empty
+      puts "PROBLEM: url_matches attribute empty.\n" \
+      "The url_matches attribute is empty on the definition " \
+      "'#{retrieve_class(caller)}'.\n\n"
+      raise Tapestry::Errors::NoUrlMatchForDefinition
+    end
+
+    def no_url_match_is_possible
+      puts "PROBLEM: No url_is or url_matches attribute.\n" \
+      "You called a '#{retrieve_method(caller)}' action but the " \
+      "definition '#{self.class}' has no url_is attribute nor a " \
+      "url_matches attribute.\n\n"
+      raise Tapestry::Errors::NoUrlMatchPossible
+    end
+
+    def title_is_empty
+      puts "PROBLEM: title_is attribute empty.\n" \
+      "The title_is attribute is empty on the definition " \
+      "'#{retrieve_class(caller)}'.\n\n"
+      raise Tapestry::Errors::NoTitleForDefinition
+    end
+
+    def no_title_is_provided
+      puts "PROBLEM: No title provided.\n" \
+      "You called a '#{retrieve_method(caller)}' action but the " \
+      "definition '#{self.class}' does not have a title_is attribute.\n\n"
+      raise Tapestry::Errors::NoTitleForDefinition
+    end
+
+    def not_ready_validation(message)
+      puts "PROBLEM: A ready validation error was encountered.\n" \
+      "A ready validation failed to validate. The ready check was " \
+      "on the '#{self.class}' definition. " \
+      "The reason provided was:\n" \
+      "#{message}.\n\n"
+      raise Tapestry::Errors::PageNotValidatedError, message
+    end
+
+    def no_ready_check_possible
+      puts "PROBLEM: A when ready call has no action.\n" \
+      "You called a when_ready on a definition but did not provide " \
+      "any action for it. Add a block with logic that should be " \
+      "executed if the ready check passes.\n\n"
+      raise Tapestry::Errors::NoBlockForWhenReady
+    end
+
+    def retrieve_class(caller)
+      caller[1][/`.*'/][8..-3]
+    end
+
+    def retrieve_method(caller)
+      caller[0][/`.*'/][1..-2]
+    end
+  end
+end

data/lib/tapestry/version.rb

@@ -1,3 +1,24 @@
 module Tapestry
-  VERSION = "0.1.0".freeze
+  module_function
+
+  VERSION = "0.2.0".freeze
+
+  def version
+    """
+Tapestry v#{Tapestry::VERSION}
+watir: #{gem_version('watir')}
+selenium-webdriver: #{gem_version('selenium-webdriver')}
+    """
+  end
+
+  def dependencies
+    Gem.loaded_specs.values.map { |spec| "#{spec.name} #{spec.version}\n" }
+       .uniq.sort.join(",").split(",")
+  end
+
+  def gem_version(name)
+    Gem.loaded_specs[name].version
+  rescue NoMethodError
+    puts "No gem loaded for #{name}."
+  end
 end

data/tapestry.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.14"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "simplecov"
   spec.add_development_dependency "rubocop"
   spec.add_development_dependency "pry"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tapestry
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jeff Nyman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-30 00:00:00.000000000 Z
+date: 2017-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -114,9 +128,22 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- examples/tapestry-data-set.rb
+- examples/tapestry-events.rb
+- examples/tapestry-factory.rb
 - examples/tapestry-simple.rb
 - lib/tapestry.rb
+- lib/tapestry/attribute.rb
 - lib/tapestry/element.rb
+- lib/tapestry/errors.rb
+- lib/tapestry/extensions/data_setter.rb
+- lib/tapestry/extensions/dom_observer.js
+- lib/tapestry/extensions/dom_observer.rb
+- lib/tapestry/extensions/watir_elements.rb
+- lib/tapestry/factory.rb
+- lib/tapestry/interface.rb
+- lib/tapestry/ready.rb
+- lib/tapestry/situation.rb
 - lib/tapestry/version.rb
 - tapestry.gemspec
 homepage: https://github.com/jeffnyman/tapestry
@@ -124,7 +151,7 @@ licenses:
 - MIT
 metadata: {}
 post_install_message: "\n(::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)\n
-  \ Tapestry 0.1.0 has been installed.\n(::) (::) (::) (::) (::) (::) (::) (::) (::)
+  \ Tapestry 0.2.0 has been installed.\n(::) (::) (::) (::) (::) (::) (::) (::) (::)
   (::) (::) (::)\n  "
 rdoc_options: []
 require_paths: