capybara_active_admin 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffad605d6aa8c00d8bd2c3e52a6e951965adca36ec416e73051793b163d83757
-  data.tar.gz: 68b2c38a0fe0ee8f711cad15982495e3d5f6680a284c65232d5ffefa05ae9aad
+  metadata.gz: b4c255bc74004f32015b353e3e06e0915d8bbc40b3109ad02cbe831eebb8b31f
+  data.tar.gz: c20f9d6fc40394244c59a00ee41db8836286eb96bf766c14a8ac4042d6db868b
 SHA512:
-  metadata.gz: 63dfa20b4d356d3759617a2c81ee57dd06bddc4beefdc3b4cdefa650a5a116687ec9ad108fbd494a6e83b1b0447f893175cc7b72f27438c48fc8d76ba060e8f7
-  data.tar.gz: 1b67771979a8b8ab0e255112bf585eb97611226b08fa258debc409042803a022d81a5b74539d1839b14011d2cbfc00ab5f7404c0092c458d11f9974a87a39af9
+  metadata.gz: 7bcf06a3023243b731c03b26643e6007ab679830af7cf27db6962b5513ac11125f9a6573f78fa296e2eeced96ea9ebd3f7af20a55de35090e6611e9e91a3a6e1
+  data.tar.gz: e307113050bcee41a41c1d1d4742b3fb5c904ae351977b3964d7c05897837b4a354d12453acacdb5edb29c5895d00f69a9d163f1b2e72248cf1dd81dd2d8a072

data/.gitignore

@@ -13,3 +13,7 @@
 .rspec_status
 
 Gemfile.lock
+
+# docs
+/docs/.vuepress/dist/
+/node_modules/

data/.travis.yml

@@ -1,12 +1,44 @@
 ---
+# test config on https://config.travis-ci.com/explore
 language: ruby
 cache: bundler
+before_install:
+  - gem install bundler -v 2.1.4
+stages:
+  - test
+  - deploy
 jobs:
   include:
-    - rvm: 2.5.7
+    - name: "Test Ruby-2.5.7 Rails-6.0"
+      stage: test
+      rvm: 2.5.7
       env: RAILS_VERSION="~> 6.0"
-    - rvm: 2.5.7
-      env: RAILS_VERSION="~> 5.0"
-    - rvm: 2.3.8
+      before_script: bundle install
+      script: bundle exec rake default
+    - name: "Test Ruby-2.5.7 Rails-5.2"
+      stage: test
+      rvm: 2.5.7
       env: RAILS_VERSION="~> 5.2"
-before_install: gem install bundler -v 2.1.4
+      before_script: bundle install
+      script: bundle exec rake default
+    - name: "Test Ruby-2.3.8 Rails-5.2"
+      stage: test
+      rvm: 2.3.8
+      env: RAILS_VERSION="~> 5.2"
+      before_script: bundle install
+      script: bundle exec rake default
+    - name: "Deploy documentation"
+      stage: deploy
+      install: skip
+      before_script: yarn install
+      script: yarn docs:build
+      deploy:
+        provider: pages
+        edge: true
+        verbose: true
+        cleanup: false
+        local_dir: docs/.vuepress/dist
+        token: $GITHUB_TOKEN
+        keep_history: true
+        on:
+          branch: master

data/CHANGELOG.md

@@ -6,6 +6,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.3.2] - 2020-04-16
+### Changed
+ - remove model_name from table related DSL arguments
+ - improve API
+
 ## [0.3.1] - 2020-04-15
 ### Added
  - `within_attribute_row` finder

data/README.md

@@ -1,9 +1,11 @@
 # Capybara Active Admin
 
-[![Build Status](https://travis-ci.com/activeadmin-plugins/capybara_active_admin.svg?branch=master)](https://travis-ci.com/activeadmin-plugins/capybara_active_admin)
+[![Build Status](https://travis-ci.com/activeadmin-plugins/capybara_active_admin.svg?branch=master)](https://travis-ci.com/activeadmin-plugins/capybara_active_admin) [![Gem Version](https://badge.fury.io/rb/capybara_active_admin.svg)](https://badge.fury.io/rb/capybara_active_admin) [![Downloads](https://img.shields.io/gem/dt/capybara_active_admin)](https://rubygems.org/gems/capybara_active_admin) [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
 
 Capybara DSL for fast and easy testing Active Admin applications.
 
+Check out our docs at [activeadmin-plugins.github.io/capybara_active_admin](https://activeadmin-plugins.github.io/capybara_active_admin)
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/deploy.sh

@@ -0,0 +1,19 @@
+#!/usr/bin/env sh
+
+# abort on errors
+set -e
+
+# build
+npm run docs:build
+
+# navigate into the build output directory
+cd docs/.vuepress/dist
+
+git init
+git add -A
+git commit -m 'deploy'
+
+# deploying to https://activeadmin-plugins.github.io/capybara_active_admin
+git push -f git@github.com:activeadmin-plugins/capybara_active_admin.git master:gh-pages
+
+cd -

data/docs/.vuepress/config.js

@@ -0,0 +1,11 @@
+module.exports = {
+  title: 'Capybara Active Admin',
+  description: 'Capybara DSL for fast and easy testing Active Admin applications.',
+  base: '/capybara_active_admin/',
+  themeConfig: {
+    nav: [
+      { text: 'Guide', link: '/guide/' },
+      { text: 'GitHub', link: 'https://github.com/activeadmin-plugins/capybara_active_admin' }
+    ]
+  }
+}

data/docs/.vuepress/styles/index.styl

@@ -0,0 +1,3 @@
+div.theme-default-content:not(.custom) {
+  max-width: 75%;
+}

data/docs/README.md

@@ -0,0 +1,41 @@
+---
+home: true
+actionText: Get Started →
+actionLink: /guide/
+footer: MIT Licensed | Copyright © 2020-present Denis Talakevich
+---
+
+<div style="text-align: center">
+  <Bit/>
+</div>
+
+<div class="features">
+  <div class="feature">
+    <h2>Fast Test Writing</h2>
+    <p>Allow to focus on what you want to test instead of how to do it.</p>
+  </div>
+  <div class="feature">
+    <h2>Simplicity</h2>
+    <p>Following Ruby an Capybara naming conventions allows easily to read and understand tests code.</p>
+  </div>
+  <div class="feature">
+    <h2>Customizable</h2>
+    <p>You can easy extend, customize, and mix parts of library to fit your needs.</p>
+  </div>
+</div>
+
+### As Easy as 1, 2, 3
+
+```bash
+# install
+gem install capybara_active_admin
+# OR echo "gem 'capybara_active_admin', group: :test, require: false" >> Gemfile
+```
+```ruby
+# require in in rspec/rails_helper.rb
+require 'capybara/active_admin/rspec'
+```
+
+::: warning COMPATIBILITY NOTE
+requires Ruby >= 2.3.
+:::

data/docs/guide/README.md

@@ -0,0 +1,113 @@
+# Introduction
+
+<Bit/>
+
+`Capybara::ActiveAdmin` created to write tests as fast as `ActiveAdmin` resource which they are test.
+
+## Getting Started
+
+### Installation
+ 
+```ruby
+# Gemfile
+
+gem 'capybara_active_admin', group: :test, require: false
+```
+
+```ruby
+# spec/rails_helper.rb
+
+# after require 'rspec' or 'rspec/rails'
+require 'capybara/active_admin/rspec'
+```
+
+### Usage
+
+For example we have such database table
+```ruby
+create_table :users do |t|
+  t.string :full_name
+  t.timestamps
+end
+```
+And such `ActiveRecord` model
+```ruby
+class User < ActiveRecord::Base
+  validates :full_name, presence: true
+end
+```
+And there is our `ActiveAdmin` resource
+```ruby
+ActiveAdmin.register User do
+  permit_params :full_name
+end
+```
+
+Our test can look like below
+```ruby
+# spec/system/users_spec.rb
+
+RSpec.describe 'Users' do
+
+  describe 'index page' do
+    subject do
+      visit admin_users_path
+    end
+
+    it 'have no table' do
+      subject
+
+      expect(page).to have_text('There are no Users yet.')
+      expect(page).to have_action_item('New User')
+      expect(page).to_not have_action_item('Edit User')
+      expect(page).to_not have_table
+    end
+
+    context 'with users' do
+      let!(:users) do
+        [
+          User.create!(full_name: 'John Doe'),
+          User.create!(full_name: 'Jane Air')
+        ]
+      end
+
+      it 'have correct table rows' do
+        subject
+
+        # you can check that table is visible on page
+        expect(page).to have_table
+
+        # checkout data within table,
+        # same as `within(table_selector) do`
+        within_table_for do
+          # check how many rows in table (tr)
+          expect(page).to have_table_row(count: 2)
+          # or cells (td)
+          expect(page).to have_table_cell(count: 10)
+          # or check cell of specific column contain specific value,
+          # accepts same options as `have_selector`, such as :text, :exact_text, :count, etc.
+          expect(page).to have_table_cell(text: 'John Doe', column: 'Full Name')
+
+          # we can check data inside specific row by record id,
+          # or we can find it by index in table `within_table_row(index: 0) do`.
+          within_table_row(id: users.first.id) do
+            # default columns for users table are id, full_name, created_at, updated_at, actions.
+            expect(page).to have_table_cell(count: 5)
+            expect(page).to have_table_cell(text: 'John Doe')
+            # or you can write
+            expect(page).to have_table_cell(text: 'John Doe', column: 'Full Name')
+            # negate matcher
+            expect(page).to_not have_table_cell(text: 'John Doe', column: 'Id')
+          end
+
+          within_table_row(id: users.second.id) do
+            expect(page).to have_table_cell(text: users.second.id, column: 'Id')
+            expect(page).to have_table_cell(text: 'Jane Air', column: 'Full Name')
+            expect(page).to_not have_table_cell(text: 'John Doe')
+          end
+        end
+      end
+    end
+  end
+end
+```

data/lib/capybara/active_admin/actions/layout.rb

@@ -3,6 +3,7 @@
 module Capybara
   module ActiveAdmin
     module Actions
+      # Actions for common Active Admin components.
       module Layout
         def click_action_item(title, options = {})
           within(action_items_container_selector) do

data/lib/capybara/active_admin/finders.rb

@@ -7,9 +7,12 @@ require 'capybara/active_admin/finders/form'
 
 module Capybara
   module ActiveAdmin
+    # Finders are methods that find DOM element(s) or change current scope to node element.
+    #
+    # Find element(s) method names should start with *find_*.
+    #
+    # Change current scope method names should start with *within_*.
     module Finders
-      # Finders are methods that find node element(s) or change current scope to node element.
-
       include Finders::Layout
       include Finders::Table
       include Finders::AttributesTable

data/lib/capybara/active_admin/finders/attributes_table.rb

@@ -3,15 +3,21 @@
 module Capybara
   module ActiveAdmin
     module Finders
+      # Finder methods for ActiveAdmin attributes_table_for can be found here.
+      # @see Capybara::ActiveAdmin::Finders base finders module.
       module AttributesTable
-        # @param model_name [Class<Object>, nil] model name or class.
-        # @param record_id [String, Numeric, nil]
-        # @yield within attributes table
-        def within_attributes_table_for(model_name, record_id = nil)
-          selector = attributes_table_selector(model_name, record_id)
+        # Calls block within attributes table.
+        # @param model [Class<Object>, nil] model name or class.
+        # @param id [String, Numeric, nil] record ID.
+        # @yield within attributes table.
+        def within_attributes_table_for(model: nil, id: nil)
+          selector = attributes_table_selector(model: model, id: id)
           within(selector) { yield }
         end
 
+        # Calls block within attributes table row.
+        # @param label [String] row label.
+        # @yield within attributes table.
         def within_attribute_row(label)
           selector = attributes_row_selector(label)
           within(selector) { yield }

data/lib/capybara/active_admin/finders/form.rb

@@ -3,17 +3,17 @@
 module Capybara
   module ActiveAdmin
     module Finders
+      # Finders for *active_admin_form_for* and related form components.
       module Form
-        # @param name [Class<Object>, String] form record class or model name
+        # @param model_name [Class<Object>, String, nil] form record class or model name (default nil).
         # @yield within form
-        def within_form_for(name)
-          name = name.model_name.singular if name.is_a?(Class)
-          selector = form_selector(name)
+        def within_form_for(model_name = nil)
+          selector = form_selector(model_name)
           within(selector) { yield }
         end
 
         # @param association_name [String]
-        # @param index [String] index of fieldset, starts with 0.
+        # @param index [String] index of fieldset, starts with 0 (default 0).
         # @yield within fieldset>ol
         def within_form_has_many(association_name, index: 0)
           selector = has_many_fields_selector(association_name)
@@ -22,6 +22,7 @@ module Capybara
           within(fieldset) { yield }
         end
 
+        # @yield within filters container.
         def within_filters
           selector = filter_form_selector
           within(selector) { yield }

data/lib/capybara/active_admin/finders/layout.rb

@@ -3,6 +3,7 @@
 module Capybara
   module ActiveAdmin
     module Finders
+      # Finders for common Active Admin components.
       module Layout
         def find_footer(options = {})
           selector = footer_selector

data/lib/capybara/active_admin/finders/table.rb

@@ -3,26 +3,14 @@
 module Capybara
   module ActiveAdmin
     module Finders
+      # Finders for *table_for*, it's rows and cells.
       module Table
-        def current_table_model_name
-          @__current_table_model_name
-        end
-
-        # @param model_name [Class<#model_name>, String] records class or model name to match rows.
         # @param resource_name [String, nil] resource name of index page.
         # @yield within table
-        def within_table_for(model_name, resource_name = nil)
+        def within_table_for(resource_name = nil)
           selector = table_selector(resource_name)
 
-          within(selector) do
-            old = @__current_table_model_name
-            @__current_table_model_name = model_name
-            begin
-              yield
-            ensure
-              @__current_table_model_name = old
-            end
-          end
+          within(selector) { yield }
         end
 
         # id [String, Integer, nil] record ID.
@@ -38,11 +26,11 @@ module Capybara
           raise ArgumentError, 'must provide :id or :index' if id.nil? && index.nil?
 
           if id
-            selector = table_row_selector(current_table_model_name, id)
+            selector = table_row_selector(id)
             return find(selector)
           end
 
-          selector = table_row_selector(nil, nil)
+          selector = table_row_selector(nil)
           find_all(selector, minimum: index + 1)[index]
         end
 

data/lib/capybara/active_admin/matchers/attributes_table.rb

@@ -5,9 +5,9 @@ module Capybara
     module Matchers
       module AttributesTable
         def have_attributes_table(options = {})
-          model_name = options.delete(:model)
-          record_id = options.delete(:id)
-          selector = attributes_table_selector(model_name, record_id)
+          model = options.delete(:model)
+          id = options.delete(:id)
+          selector = attributes_table_selector(model: model, id: id)
           have_selector(selector, options)
         end