capybara_active_admin 0.3.3 → 2.0.0

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'capybara/active_admin/util'
+
 module Capybara
   module ActiveAdmin
     module Selectors
@@ -10,8 +12,12 @@ module Capybara
         def table_selector(resource_name = nil)
           return 'table.index_table' if resource_name.nil?
 
-          resource_name = resource_name.to_s.gsub(' ', '_').pluralize.downcase
-          "table#index_table_#{resource_name}"
+          # NOTE: ActiveAdmin builds this id from the registered resource name
+          # (`active_admin_config.resource_name.plural`, index_as_table.rb:240),
+          # which `register Model, as: 'Other Name'` detaches from the model.
+          # A class can only ever yield the model's own name, so a renamed
+          # resource has to be addressed by the name it was registered under.
+          "table#index_table_#{Util.parse_model_name(resource_name, singular: false)}"
         end
 
         # @param record_id [String, Integer, nil] record ID.
@@ -22,9 +28,20 @@ module Capybara
           %(tbody > tr[id$="_#{record_id}"])
         end
 
+        # @param text [String] column header text.
+        # @param options [Hash]
+        # @option column [String, nil] column name override (defaults to text).
+        # @option sortable [Boolean] whether column is sortable.
+        # @option sort_direction [String, nil] sort direction ('asc' or 'desc').
         # @return selector.
-        def table_header_selector
-          'thead > tr > th.col'
+        def table_header_selector(text = nil, options = {})
+          return 'thead > tr > th.col' if text.nil? && options[:column].nil?
+
+          column = Util.css_class_for_label(options[:column] || text)
+          selector = "th.col.col-#{column}"
+          selector += '.sortable' if options[:sortable]
+          selector += ".sorted-#{options[:sort_direction].to_s.downcase}" if options[:sort_direction].present?
+          "thead > tr > #{selector}"
         end
 
         # @param column [String, nil] column name.
@@ -32,9 +49,17 @@ module Capybara
         def table_cell_selector(column = nil)
           return 'td.col' if column.nil?
 
-          column = column.to_s.gsub(' ', '_').downcase
+          column = Util.css_class_for_label(column)
           "td.col.col-#{column}"
         end
+
+        def table_scopes_container_selector
+          '.scopes > ul.table_tools_segmented_control'
+        end
+
+        def table_scope_selector
+          'li.scope'
+        end
       end
     end
   end

data/lib/capybara/active_admin/util.rb

@@ -5,12 +5,49 @@ module Capybara
     module Util
       # Common pure utility functions
 
+      # Arbre derives a record's DOM name from
+      # `record.class.model_name.singular`, falling back to
+      # `name.underscore.gsub('/', '_')` (arbre html/tag.rb:164-168). Ask the
+      # model the same question instead of approximating it: `gsub(' ', '_')`
+      # leaves the `::` of a namespaced name in place, and
+      # `div.attributes_table.billing::employee` is not a selector -- Nokogiri
+      # raises `SyntaxError` on it with nothing pointing at the cause.
       def parse_model_name(model_name, singular: true)
         return if model_name.nil?
 
-        model_name = model_name.model_name.singular if model_name.is_a?(Class)
-        model_name = model_name.to_s.gsub(' ', '_').downcase
-        singular ? model_name.singularize : model_name.pluralize
+        if model_name.is_a?(Class) && model_name.respond_to?(:model_name)
+          name = model_name.model_name
+          return singular ? name.singular : name.plural
+        end
+
+        dom_model_name(model_name.is_a?(Class) ? model_name.name : model_name, singular: singular)
+      end
+
+      def dom_model_name(name, singular: true)
+        name = name.to_s.underscore.tr('/', '_').tr(' ', '_')
+        singular ? name.singularize : name.pluralize
+      end
+
+      # ActiveAdmin derives the CSS class of a row or column from the
+      # label with `parameterize(separator: '_')` --
+      # `AttributesTable#row` and `TableFor::Column#html_class`. Mirror
+      # that call rather than approximating it, so every label lands on
+      # the class ActiveAdmin actually rendered.
+      def css_class_for_label(label)
+        css_class = label.to_s.parameterize(separator: '_')
+        return css_class if css_class.present?
+
+        # `parameterize` transliterates to Latin and drops the rest, so any
+        # label without Latin-transliterable characters -- 'Имя', '名前', '№',
+        # or a blank string -- comes back empty. ActiveAdmin makes the same
+        # call, so it renders `class="row row-"` for all of them, and a
+        # `.row-` selector would match every one at once: the matcher would
+        # pass against the wrong row instead of failing. Refuse to build it.
+        raise ArgumentError,
+              "cannot derive a CSS class from #{label.inspect}: " \
+              'ActiveAdmin parameterizes it to an empty string, so every such ' \
+              'row or column shares one class and cannot be told apart. ' \
+              'Match on text, or pass the attribute name instead of the label.'
       end
 
       def options_with_text(text, options = {})
@@ -19,7 +56,7 @@ module Capybara
         options.except(:exact).merge(key => text)
       end
 
-      module_function :parse_model_name, :options_with_text
+      module_function :parse_model_name, :dom_model_name, :css_class_for_label, :options_with_text
     end
   end
 end

data/lib/capybara/active_admin/version.rb

@@ -2,6 +2,6 @@
 
 module Capybara
   module ActiveAdmin
-    VERSION = '0.3.3'
+    VERSION = '2.0.0'
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: capybara_active_admin
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 2.0.0
 platform: ruby
 authors:
 - Denis Talakevich
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-17 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeadmin
@@ -16,14 +15,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -45,24 +50,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
-- capybara_active_admin.gemspec
-- docs/.vuepress/config.js
-- docs/.vuepress/public/.keep
-- docs/.vuepress/styles/index.styl
-- docs/README.md
-- docs/guide/README.md
 - lib/capybara/active_admin.rb
 - lib/capybara/active_admin/actions.rb
 - lib/capybara/active_admin/actions/attributes_table.rb
@@ -89,8 +79,6 @@ files:
 - lib/capybara/active_admin/util.rb
 - lib/capybara/active_admin/version.rb
 - lib/capybara_active_admin.rb
-- package.json
-- yarn.lock
 homepage: https://github.com/active_admin_plugins/capybara_active_admin
 licenses:
 - MIT
@@ -98,7 +86,6 @@ metadata:
   homepage_uri: https://github.com/active_admin_plugins/capybara_active_admin
   source_code_uri: https://github.com/active_admin_plugins/capybara_active_admin
   changelog_uri: https://github.com/active_admin_plugins/capybara_active_admin/blob/master/CHANGELOG.md
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -106,15 +93,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Capybara DSL for fast and easy testing Active Admin applications.
 test_files: []

data/.gitignore

@@ -1,20 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-/spec/dummy/tmp/
-/spec/dummy/log/*.log
-
-# rspec failure tracking
-.rspec_status
-
-Gemfile.lock
-
-# docs
-/docs/.vuepress/dist/
-/docs/.vuepress/public/api/
-/node_modules/

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require rails_helper

data/.rubocop.yml

@@ -1,82 +0,0 @@
-AllCops:
-  DisplayCopNames: true
-  TargetRubyVersion: 2.3
-  Exclude:
-    - vendor/**/*
-    - tmp/**/*
-    - docs/**/*
-
-# Capybara/RSpec uses have_ had_ as name convention for matchers.
-Naming/PredicateName:
-  Enabled: false
-
-Lint/RaiseException:
-  Enabled: true
-
-Lint/StructNewOverride:
-  Enabled: true
-
-Layout/LineLength:
-  Max: 180
-
-Style/SymbolArray:
-  EnforcedStyle: brackets
-
-Style/Lambda:
-  EnforcedStyle: literal
-
-Naming/MethodParameterName:
-  AllowedNames:
-    - id
-
-Style/HashEachMethods:
-  Enabled: true
-
-Style/HashTransformKeys:
-  Enabled: true
-
-Style/HashTransformValues:
-  Enabled: true
-
-Style/Documentation:
-  Enabled: false
-
-Metrics/PerceivedComplexity:
-  Enabled: false
-
-Metrics/MethodLength:
-  Enabled: false
-
-Metrics/AbcSize:
-  Enabled: false
-
-Metrics/ModuleLength:
-  Enabled: false
-
-Metrics/BlockLength:
-  Enabled: false
-
-Metrics/ClassLength:
-  Enabled: false
-
-Metrics/CyclomaticComplexity:
-  Enabled: false
-
-Layout/MultilineOperationIndentation:
-  Enabled: false
-
-Layout/FirstHashElementIndentation:
-  Enabled: false
-
-Layout/FirstArrayElementIndentation:
-  Enabled: false
-
-Layout/FirstArgumentIndentation:
-  Enabled: false
-
-Layout/ClosingParenthesisIndentation:
-  Enabled: false
-
-Layout/ArgumentAlignment:
-  Enabled: false
-

data/.travis.yml

@@ -1,45 +0,0 @@
----
-# 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:
-    - name: "Test Ruby-2.5.7 Rails-6.0"
-      stage: test
-      rvm: 2.5.7
-      env: RAILS_VERSION="~> 6.0"
-      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_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
-      before_script: yarn install
-      script:
-        - bundle exec rake yard
-        - 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/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at senid231@gmail.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [https://contributor-covenant.org/version/1/4][version]
-
-[homepage]: https://contributor-covenant.org
-[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in capybara_active_admin.gemspec
-gemspec
-
-gem 'capybara'
-gem 'selenium-webdriver'
-# https://github.com/mattheworiordan/capybara-screenshot/issues/225#issuecomment-409407825
-gem 'cuprite'
-gem 'puma'
-gem 'rake', '~> 12.0'
-gem 'rspec-rails', '~> 4.0'
-gem 'rubocop', '~> 0.81.0', require: false
-gem 'system_test_html_screenshots', require: false
-gem 'yard', require: false
-
-gem 'activeadmin', ENV.fetch('ACTIVE_ADMIN_VERSION', '~> 2.0'), require: false
-gem 'rails', ENV.fetch('RAILS_VERSION', '6.0.0')
-gem 'sassc-rails', '2.1.2'
-gem 'sprockets', '3.7.2'
-gem 'sqlite3', '1.4.1'

data/Rakefile

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-require 'rubocop/rake_task'
-require 'yard'
-require 'yard/rake/yardoc_task'
-
-RSpec::Core::RakeTask.new(:spec)
-RuboCop::RakeTask.new(:rubocop)
-YARD::Rake::YardocTask.new(:yard) do |task|
-  task.options += [
-      %(--output-dir=./docs/.vuepress/public/api/),
-      %(--title=Capybara Active Admin API Reference)
-  ]
-end
-
-task default: [:rubocop, :spec]

data/bin/console

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'bundler/setup'
-require 'capybara_active_admin'
-
-# 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(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/capybara_active_admin.gemspec

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'lib/capybara/active_admin/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'capybara_active_admin'
-  spec.version       = Capybara::ActiveAdmin::VERSION
-  spec.authors       = ['Denis Talakevich']
-  spec.email         = ['senid231@gmail.com']
-
-  spec.summary       = 'Capybara DSL for fast and easy testing Active Admin applications.'
-  spec.description   = 'Capybara DSL for fast and easy testing Active Admin applications.'
-  spec.homepage      = 'https://github.com/active_admin_plugins/capybara_active_admin'
-  spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
-
-  spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = spec.homepage
-  spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/master/CHANGELOG.md"
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-
-  spec.add_dependency 'activeadmin'
-  # spec.add_dependency 'devise'
-  spec.add_dependency 'rspec', '~> 3.0'
-end

data/docs/.vuepress/config.js

@@ -1,12 +0,0 @@
-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: 'API Reference', link: '/api/', target: '_blank' },
-      { text: 'GitHub', link: 'https://github.com/activeadmin-plugins/capybara_active_admin' }
-    ]
-  }
-}

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

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

data/docs/README.md

@@ -1,41 +0,0 @@
----
-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.
-:::