RubyGems - mache - Versions diffs - 1.0.0 - Mend

mache 1.0.0

Files changed (19) hide show

checksums.yaml ADDED Viewed

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4a33c9e84520e543f6693fd7895d9fb6c6835626
+  data.tar.gz: 7370d76223bd10fe2444e2d091e9ddd64219181a
+SHA512:
+  metadata.gz: 771ff8e66362d6788b046bb94e092a100dacd2f952ee960f0b2530b47eca889a0b8a2a57ba7c4ac40116214663d3d14ca89db988e861f6ed46ed1d52c0bc37a9
+  data.tar.gz: 4b203e4da5927d68605208ed06b8aa54a81d7c3c8f69d5c1f19cc13b1019e9c3fd7442cfb857aa11ac244b634d967a4fd1badcdc9e9ae3c28db66115b29b634b

data/.gitignore ADDED Viewed

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

data/.rspec ADDED Viewed

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

data/.rubocop.yml ADDED Viewed

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

data/.ruby-version ADDED Viewed

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

data/.travis.yml ADDED Viewed

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

data/Gemfile ADDED Viewed

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

data/LICENSE ADDED Viewed

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+Copyright (c) 2017 Joshua Bassett
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md ADDED Viewed

@@ -0,0 +1,170 @@
+# Mache
+[![Build Status](https://travis-ci.org/nullobject/mache.svg?branch=master)](https://travis-ci.org/nullobject/mache)
+A [page object](https://martinfowler.com/bliki/PageObject.html) library for writing cleaner acceptance tests with [Capybara](https://github.com/teamcapybara/capybara).
+## Getting started
+Consider the following HTML snippet:
+```html
+<html>
+  <body>
+    <header>
+      <h1>Welcome</h1>
+    </header>
+    <nav>
+      <a href="#" class="selected">foo</a>
+      <a href="#">bar</a>
+      <a href="#">baz</a>
+    </nav>
+    <main>
+      lorem ipsum
+    </main>
+  </body>
+</html>
+```
+To define a page object class to wrap this HTML snippet, we extend the
+`Mache::Page` class. The only method our class needs to provide is `path`, this
+tells Mache where to go when we want to visit the page.
+```ruby
+class WelcomePage < Mache::Page
+  def path
+    "/welcome"
+  end
+end
+```
+This is how we visit our page object:
+```ruby
+page = WelcomePage.visit
+page.current? # true
+```
+Any Capybara API methods will be forwarded to the underlying node:
+```ruby
+page.find("body > main").text # "lorem ipsum"
+```
+### Elements
+To make our page object more useful, we can define an element on our page
+object class using the `element` macro. An element is simply a HTML element
+that we expect to find on the page using a CSS selector.
+Let's define a `main` element:
+```ruby
+class WelcomePage < Mache::Page
+  element :main, "body > main"
+  def path
+    "/welcome"
+  end
+end
+```
+Now we can query the element on our page object:
+```ruby
+page.has_main? # true
+page.main.visible? # true
+page.main.text # "lorem ipsum"
+```
+### Components
+For elements that can be shared across an number of page object classes, it may
+be useful to define a reusable component by extending the `Mache::Component`
+class. A component class can contain any number of elements or other
+components:
+```ruby
+class Header < Mache::Component
+  element :title, "h1"
+end
+```
+Our page object class can mount our component at a given CSS selector using the
+`component` macro:
+```ruby
+class WelcomePage < Mache::Page
+  component :header, Header, "header"
+  element :main, "body > main"
+  def path
+    "/welcome"
+  end
+end
+```
+Querying a component on our page object is much the same as an element:
+```ruby
+page.has_header? # true
+page.header.visible? # true
+page.header.title.text # "Welcome"
+```
+## Example
+Let's look at a more complete example for our `WelcomePage`:
+```ruby
+class Header < Mache::Component
+  element :title, "h1"
+end
+class NavItem < Mache::Component
+  def selected?
+    node[:class].include?("selected")
+  end
+end
+class Nav < Mache::Component
+  components :items, NavItem, "a"
+end
+class WelcomePage < Mache::Page
+  component :header, Header, "header"
+  component :nav, Nav, "nav"
+  element :main, "main"
+  def path
+    "/welcome"
+  end
+end
+```
+We can use our page objects to write expressive tests:
+```ruby
+feature "Home page" do
+  let(:home_page) { WelcomePage.visit }
+  scenario "A user visits the home page" do
+    expect(home_page).to be_current
+    expect(home_page).to have_header
+    expect(home_page.header.title).to eq("Welcome")
+    expect(home_page).to have_nav
+    expect(home_page.nav).to have_items
+    expect(home_page.nav.items.count).to be(3)
+    expect(home_page.nav.items[0].text).to eq("foo")
+    expect(home_page.nav.items[1].text).to eq("bar")
+    expect(home_page.nav.items[2].text).to eq("baz")
+    expect(home_page.nav.items[0]).to be_selected
+    expect(home_page.main.text).to eq("lorem ipsum")
+  end
+end
+```

data/Rakefile ADDED Viewed

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

data/bin/console ADDED Viewed

@@ -0,0 +1,14 @@
+#!/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/lib/mache/component.rb ADDED Viewed

@@ -0,0 +1,6 @@
+require "mache/node"
+module Mache
+  class Component < Node
+  end
+end

data/lib/mache/dsl.rb ADDED Viewed

@@ -0,0 +1,58 @@
+module Mache
+  # Provides the mache DSL for nodes.
+  module DSL
+    def self.included(base)
+      base.extend ClassMethods
+    end
+    module ClassMethods #:nodoc:
+      def automation(*ids)
+        ids.map { |id| %([data-automation="#{id}"]) }.join(" ")
+      end
+      def element(name, selector)
+        define_method(name.to_s) do
+          @node.find(selector)
+        end
+        define_helper_methods(name, selector)
+      end
+      def elements(name, selector)
+        define_method(name.to_s) do
+          @node.all(selector, minimum: 1)
+        end
+        define_helper_methods(name, selector)
+      end
+      def component(name, type, selector)
+        define_method(name.to_s) do
+          type.new(@node.find(selector))
+        end
+        define_helper_methods(name, selector)
+      end
+      def components(name, type, selector)
+        define_method(name.to_s) do
+          @node.all(selector, minimum: 1).map { |element| type.new(element) }
+        end
+        define_helper_methods(name, selector)
+      end
+      private
+      def define_helper_methods(name, selector)
+        define_existence_predicates(name, selector)
+      end
+      def define_existence_predicates(name, selector)
+        define_method("has_#{name}?") do
+          @node.has_selector?(selector)
+        end
+        define_method("has_no_#{name}?") do
+          @node.has_no_selector?(selector)
+        end
+      end
+    end
+  end
+end

data/lib/mache/node.rb ADDED Viewed

@@ -0,0 +1,27 @@
+require "mache/dsl"
+module Mache
+  # An abstract class that wraps a capybara node object and exposes the mache
+  # DSL. It also delegates any capybara methods to the underlying node object.
+  class Node
+    include DSL
+    attr_reader :node
+    def initialize(node)
+      @node = node
+    end
+    def method_missing(name, *args, &block)
+      if @node.respond_to?(name)
+        @node.send(name, *args, &block)
+      else
+        super
+      end
+    end
+    def respond_to_missing?(name, include_private = false)
+      @node.respond_to?(name) || super
+    end
+  end
+end

data/lib/mache/page.rb ADDED Viewed

@@ -0,0 +1,28 @@
+require "capybara"
+require "mache/node"
+module Mache
+  # A page provides a DSL for querying a wrapped capybara node object node. A
+  # page can also has a path which can be visited.
+  class Page < Node
+    attr_reader :path
+    def initialize(node: Capybara.current_session, path: nil)
+      @node ||= node
+      @path ||= path
+    end
+    def visit
+      @node.visit(path)
+      self
+    end
+    def current?
+      @node.current_path == path
+    end
+    def self.visit
+      new.tap(&:visit)
+    end
+  end
+end

data/lib/mache/version.rb ADDED Viewed

@@ -0,0 +1,3 @@
+module Mache
+  VERSION = "1.0.0".freeze
+end

data/lib/mache.rb ADDED Viewed

@@ -0,0 +1,3 @@
+require "mache/component"
+require "mache/page"
+require "mache/version"

data/mache.gemspec ADDED Viewed

@@ -0,0 +1,27 @@
+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 page object library for writing cleaner acceptance tests with Capybara."
+  spec.description = "Mache provides a DSL for writing page object clases to use in your acceptance tests."
+  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

metadata ADDED Viewed

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: mache
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Joshua Bassett
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2017-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.47'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.47'
+description: Mache provides a DSL for writing page object clases to use in your acceptance
+  tests.
+email:
+- josh.bassett@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- lib/mache.rb
+- lib/mache/component.rb
+- lib/mache/dsl.rb
+- 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:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.5.2
+signing_key:
+specification_version: 4
+summary: A page object library for writing cleaner acceptance tests with Capybara.
+test_files: []