mache 2.1.1 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f2a6457504e07023cbe3e84e72ef455a22081ecd
-  data.tar.gz: cce7b3211712bfa08b179b9b9cd8f237eca299b3
+SHA256:
+  metadata.gz: d3a2af226ce51ad3f1edc15475a67a5b9a2fdd4a81b65d46a2f847e664a58227
+  data.tar.gz: 5b66d43a77bb704f598909d34a4f512bb08d81a5f1fcb2ce914ea48ff3b46589
 SHA512:
-  metadata.gz: 2ca5d81a94c1c56716d9e9411abf47bac750198dd07950d049bbcb4612dcf6ded9e96c3b3eddcb91f428be49846772d179e37074e1aeb8956b880f0dd8fb5e3c
-  data.tar.gz: 15b0571b00474011618204d7eb7e82fcdbac3d06ccda60f0ea55ca39dc7a05c3206a6e1fd020a31a1dc6eb19ff75df8919727e43f350cd7d4f0fbb7b7dfe906b
+  metadata.gz: 4e1ab401e8d8763b1ad2e4b582da83268479b3777bb7734ad90cfc7fbe7659cada443391b2e7966ffc99d4c5a3313e904e8988664577943a4512e4c211dd0570
+  data.tar.gz: 93d87a2b414db501060f26d4a0bfdeaa4e45c3ed10721a5f4c1313cb27dc16b055638af6ab24cb6887cebcc470c6374608a77ce0e3897a5fc0eaeb20be98d67a

data/CHANGELOG.md

@@ -1,22 +1,33 @@
-# Changelog
+## 3.2.0 (2022-03-29)
+
+* Fix Capybara errors on Ruby 3.1
+
+## 3.1.0 (2019-04-30)
+
+* Add `empty` method to `Node` class
+
+## 3.0.0
+
+* Upgrade capybara
+* Update documentation
 
 ## 2.1.1
 
-- Fix a bug in the flash helper matchers.
+* Fix a bug in the flash helper matchers
 
 ## 2.1.0
 
-- Add flash and routing helpers.
+* Add flash and routing helpers
 
 ## 2.0.0
 
-- Ensure the klass argument is a subclass of `Node` in the DSL methods.
-- Remove `Component` class.
+* Ensure the klass argument is a subclass of `Node` in the DSL methods
+* Remove `Component` class
 
 ## 1.0.1
 
-- Update documentation.
+* Update documentation
 
 ## 1.0.0
 
-- Initial release.
+* Initial release

data/README.md

@@ -5,21 +5,18 @@
 Mâché (pronounced "mash-ay") is a tool that helps you to write cleaner and more
 expressive acceptance tests for your Ruby web applications using page objects.
 
-## Table of contents
-
-* [Mâché](#mâché)
-  * [Table of contents](#table-of-contents)
-  * [What is a page object?](#what-is-a-page-object)
-  * [Getting started](#getting-started)
-    * [Elements](#elements)
-    * [Components](#components)
-    * [Helpers](#helpers)
-  * [Example](#example)
-  * [API documentation](#api-documentation)
-  * [Contributing](#contributing)
-  * [License](#license)
-
-## What is a page object?
+## Table of Contents
+
+* [What is a Page Object?](#what-is-a-page-object)
+* [Getting Started](#getting-started)
+  * [Elements](#elements)
+  * [Components](#components)
+  * [Helpers](#helpers)
+* [Examples](#examples)
+* [Documentation](#documentation)
+* [License](#license)
+
+## What is a Page Object?
 
 A [page object](https://martinfowler.com/bliki/PageObject.html) is a data
 structure that provides an interface to your web application for the purposes
@@ -39,12 +36,12 @@ low-level API methods like `find`, `fill_in`, and `click_button`, but it
 doesn't provide us with high-level methods to do things like "sign in to the
 app" or "click the Dashboard item in the navigation bar".
 
-This is where page objects come in. Using Mâché we can for instance define a
-page object class called `SignInPage` and use it any time we want to automate
+This is where page objects come in. Using Mâché, we can define a page object
+class called `SignInPage` and use it any time we want to automate
 authenticating with our app. It could handle visiting the sign in page,
 entering the user's credentials, and clicking the "Sign in" button.
 
-## Getting started
+## Getting Started
 
 Let's dive straight in and take a look at an example. Consider the following
 HTML fragment for the welcome page in our app:
@@ -216,7 +213,7 @@ class WelcomePage < Mache::Page
 end
 ```
 
-## Example
+## Examples
 
 Let's look at an example of an acceptance test for our `WelcomePage`. Note that
 the `Header`, `NavItem`, and `Nav` components can be reused in any other page
@@ -287,19 +284,10 @@ feature "Welcome page" do
 end
 ```
 
-## API documentation
-
-Read the [API documentation](http://www.rubydoc.info/gems/mache) on RubyDoc.
-
-## Contributing
+## Documentation
 
-Pull requests are welcome. Please ensure that you run the tests before
-submitting your PR:
-
-```
-> bundle exec rake
-```
+Read the [API reference](http://www.rubydoc.info/gems/mache) on RubyDoc.
 
 ## License
 
-Mâché is licensed under the [MIT License](/LICENSE).
+Mâché is licensed under the [MIT License](/LICENSE.md).

data/lib/mache/dsl.rb

@@ -55,7 +55,7 @@ module Mache
     #
     module ClassMethods
       def automation(*ids)
-        ids.map { |id| %([data-automation="#{id}"]) }.join(" ")
+        ids.map { |id| %([data-automation="#{id}"]) }.join(' ')
       end
 
       # Defines an element that wraps an HTML fragment.
@@ -65,7 +65,7 @@ module Mache
       # @param options [Hash] a hash of options to pass to the Capybara finder
       def element(name, selector, options = {})
         define_method(name.to_s) do
-          Node.new(node: @node.find(selector, options))
+          Node.new(node: @node.find(selector, **options))
         end
 
         define_helper_methods(name, selector)
@@ -80,7 +80,7 @@ module Mache
         options = {minimum: 1}.merge(options)
 
         define_method(name.to_s) do
-          @node.all(selector, options).map do |node|
+          @node.all(selector, **options).map do |node|
             Node.new(node: node)
           end
         end
@@ -96,11 +96,11 @@ module Mache
       # @param options [Hash] a hash of options to pass to the Capybara finder
       def component(name, klass, selector, options = {})
         unless klass < Node
-          raise ArgumentError, "Must be given a subclass of Node"
+          raise ArgumentError, 'Must be given a subclass of Node'
         end
 
         define_method(name.to_s) do
-          klass.new(node: @node.find(selector, options))
+          klass.new(node: @node.find(selector, **options))
         end
 
         define_helper_methods(name, selector)
@@ -114,13 +114,13 @@ module Mache
       # @param options [Hash] a hash of options to pass to the Capybara finder
       def components(name, klass, selector, options = {})
         unless klass < Node
-          raise ArgumentError, "Must be given a subclass of Node"
+          raise ArgumentError, 'Must be given a subclass of Node'
         end
 
         options = {minimum: 1}.merge(options)
 
         define_method(name.to_s) do
-          @node.all(selector, options).map do |node|
+          @node.all(selector, **options).map do |node|
             klass.new(node: node)
           end
         end

data/lib/mache/helpers/rails/flash.rb

@@ -1,10 +1,10 @@
 module Mache
   module Helpers
     module Rails
-      # The {Flash} module can be Included into page object classes that support
+      # The {Flash} module can be included into page object classes that support
       # flash behaviour.
       #
-      # rubocop:disable Style/PredicateName
+      # rubocop:disable Naming/PredicateName
       module Flash
         def self.included(base)
           base.extend(ClassMethods)
@@ -18,18 +18,18 @@ module Mache
 
         # Tests whether the page has a flash message.
         #
-        # @param [String, Symbol] type a flash message type
-        # @param [Regexp, String] text a value to match
+        # @param type [String, Symbol] a flash message type
+        # @param text [Regexp, String] a value to match
         # @return `true` if the page has a matching message, `false` otherwise
         def has_message?(type, text)
-          css_class = flash[:class] || ""
+          css_class = flash[:class] || ''
           regexp = text.is_a?(String) ? /\A#{Regexp.escape(text)}\Z/ : text
           css_class.include?(type.to_s) && flash.text.strip =~ regexp
         end
 
         # Tests whether the page has a success message.
         #
-        # @param [Regexp, String] text a value to match
+        # @param text [Regexp, String] a value to match
         # @return `true` if the page has a matching message, `false` otherwise
         def has_success_message?(text)
           has_message?(:success, text)
@@ -37,7 +37,7 @@ module Mache
 
         # Tests whether the page has a notice message.
         #
-        # @param [Regexp, String] text a value to match
+        # @param text [Regexp, String] a value to match
         # @return `true` if the page has a matching message, `false` otherwise
         def has_notice_message?(text)
           has_message?(:notice, text)
@@ -45,7 +45,7 @@ module Mache
 
         # Tests whether the page has an alert message.
         #
-        # @param [Regexp, String] text a value to match
+        # @param text [Regexp, String] a value to match
         # @return `true` if the page has a matching message, `false` otherwise
         def has_alert_message?(text)
           has_message?(:alert, text)
@@ -53,13 +53,13 @@ module Mache
 
         # Tests whether the page has an error message.
         #
-        # @param [Regexp, String] text a value to match
+        # @param text [Regexp, String] a value to match
         # @return `true` if the page has a matching message, `false` otherwise
         def has_error_message?(text)
           has_message?(:error, text)
         end
       end
-      # rubocop:enable Style/PredicateName
+      # rubocop:enable Naming/PredicateName
     end
   end
 end

data/lib/mache/helpers/rails/routes.rb

@@ -1,7 +1,7 @@
 module Mache
   module Helpers
     module Rails
-      # The {Routes} module can be Included into page object classes that
+      # The {Routes} module can be included into page object classes that
       # support routing.
       module Routes
         def self.included(base)

data/lib/mache/helpers/rails.rb

@@ -1,2 +1,2 @@
-require "mache/helpers/rails/flash"
-require "mache/helpers/rails/routes"
+require 'mache/helpers/rails/flash'
+require 'mache/helpers/rails/routes'

data/lib/mache/node.rb

@@ -1,8 +1,8 @@
-require "mache/dsl"
+require 'mache/dsl'
 
 module Mache
   # The {Node} class represents a wrapped HTML page, or fragment. It exposes all
-  # methods from the Mache {DSL}, and forwards any Capybara API methods to the
+  # methods from the Mache DSL, and forwards any Capybara API methods to the
   # {#node} object.
   #
   # @abstract
@@ -11,22 +11,39 @@ module Mache
 
     # The underlying Capybara node object wrapped by this instance.
     #
-    # @return [Capybara::Node] the node object
+    # @return [Capybara::Node] a node object
     attr_reader :node
 
     # Returns a new instance of Node.
     #
     # @param node [Capybara::Node] a Capybara node object to wrap
     def initialize(node:)
-      @node ||= node
+      @node = node
+    end
+
+    # Tests whether the node is empty.
+    #
+    # @return [Boolean] `true` if the node is empty, `false` otherwise.
+    def empty?
+      node.all('*').length.zero?
     end
 
     # Forwards any Capybara API calls to the node object.
-    def method_missing(name, *args, &block)
-      if @node.respond_to?(name)
-        @node.send(name, *args, &block)
-      else
-        super
+    if RUBY_VERSION < "3"
+      def method_missing(name, *args, &block)
+        if @node.respond_to?(name)
+          @node.send(name, *args, &block)
+        else
+          super
+        end
+      end
+    else
+      def method_missing(name, *args, **kwargs, &block)
+        if @node.respond_to?(name)
+          @node.send(name, *args, **kwargs, &block)
+        else
+          super
+        end
       end
     end
 

data/lib/mache/page.rb

@@ -1,5 +1,5 @@
-require "capybara"
-require "mache/node"
+require 'capybara'
+require 'mache/node'
 
 module Mache
   # The {Page} class wraps an HTML page with an application-specific API. You
@@ -32,13 +32,13 @@ module Mache
     # @param node [Capybara::Node] a Capybara node to attach to
     # @param path [String] a path to where the page is located
     def initialize(node: Capybara.current_session, path: nil)
-      @node ||= node
-      @path ||= path
+      @node = node
+      @path = path
     end
 
     # Visits the page at its {#path}.
     #
-    # @return [Page] the page object
+    # @return [Page] a page object
     def visit
       @node.visit(path)
       self
@@ -46,14 +46,14 @@ module Mache
 
     # Tests whether the page is current.
     #
-    # @return [Boolean] `true` if the page is current, `false` otherwise
+    # @return [Boolean] `true` if the page is current, `false` otherwise.
     def current?
       @node.current_path == path
     end
 
     # Creates a new page object and calls {#visit} on it.
     #
-    # @return [Page] the page object
+    # @return [Page] a page object
     def self.visit
       new.visit
     end

data/lib/mache/version.rb

@@ -1,3 +1,3 @@
 module Mache
-  VERSION = "2.1.1".freeze
+  VERSION = '3.2.0'.freeze
 end

data/lib/mache.rb

@@ -1,3 +1,3 @@
-require "mache/node"
-require "mache/page"
-require "mache/version"
+require 'mache/node'
+require 'mache/page'
+require 'mache/version'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mache
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 3.2.0
 platform: ruby
 authors:
 - Joshua Bassett
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-03-30 00:00:00.000000000 Z
+date: 2022-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -16,84 +16,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.14'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: 12.3.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: 12.3.2
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.0.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.0.7
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: 3.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: 3.8.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.47'
+        version: 0.67.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.47'
+        version: 0.67.2
 description: Mâché provides helps you to write cleaner and more expressive acceptance
   tests for your web applications using page objects.
 email:
@@ -102,18 +88,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".ruby-version"
-- ".travis.yml"
-- ".yardopts"
 - CHANGELOG.md
-- Gemfile
-- LICENSE
+- LICENSE.md
 - README.md
-- Rakefile
-- bin/console
 - lib/mache.rb
 - lib/mache/dsl.rb
 - lib/mache/helpers/rails.rb
@@ -122,12 +99,11 @@ files:
 - lib/mache/node.rb
 - lib/mache/page.rb
 - lib/mache/version.rb
-- mache.gemspec
 homepage: https://github.com/nullobject/mache
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -135,16 +111,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: A library for writing cleaner and more expressive acceptance tests using
   page objects.

data/.gitignore

@@ -1,4 +0,0 @@
-*.gem
-.bundle
-.yardoc
-Gemfile.lock

data/.rspec

@@ -1,2 +0,0 @@
---format documentation
---color

data/.rubocop.yml

@@ -1,22 +0,0 @@
-AllCops:
-  Exclude:
-    - "mache.gemspec"
-
-Metrics/BlockLength:
-  ExcludedMethods: describe
-
-Style/BlockDelimiters:
-  Enabled: false
-
-Style/Documentation:
-  Exclude:
-    - "spec/**/*"
-
-Style/FrozenStringLiteralComment:
-  Enabled: false
-
-Style/SpaceInsideHashLiteralBraces:
-  Enabled: false
-
-Style/StringLiterals:
-  EnforcedStyle: double_quotes

data/.ruby-version

@@ -1 +0,0 @@
-2.3.3

data/.travis.yml

@@ -1,2 +0,0 @@
-language: ruby
-before_install: gem install bundler -v 1.14.5

data/.yardopts

@@ -1 +0,0 @@
---markup markdown

data/Gemfile

@@ -1,4 +0,0 @@
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in mache.gemspec
-gemspec

data/Rakefile

@@ -1,8 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-require "rubocop/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-RuboCop::RakeTask.new
-
-task default: %w(spec rubocop)

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "mache"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start

data/mache.gemspec

@@ -1,27 +0,0 @@
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-require "mache/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "mache"
-  spec.version = Mache::VERSION
-  spec.authors = ["Joshua Bassett"]
-  spec.email = ["josh.bassett@gmail.com"]
-  spec.summary = "A library for writing cleaner and more expressive acceptance tests using page objects."
-  spec.description = "Mâché provides helps you to write cleaner and more expressive acceptance tests for your web applications using page objects."
-  spec.homepage = "https://github.com/nullobject/mache"
-  spec.license = "MIT"
-  spec.files = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "capybara", "~> 2"
-
-  spec.add_development_dependency "bundler", "~> 1.14"
-  spec.add_development_dependency "rake", "~> 12.0"
-  spec.add_development_dependency "rack", "~> 2.0"
-  spec.add_development_dependency "rspec", "~> 3.5"
-  spec.add_development_dependency "rubocop", "~> 0.47"
-end