rubocop-rails-accessibility 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2def62d1c73f8ef14e06d1eaca55ca244d12cd2e924f8a0d7025ade68f0b36a4
-  data.tar.gz: 8b229af38423902ebe468cf0d2a77803dcf0f3df785ffab6e1f43e45a55bc246
+  metadata.gz: dfefa9c0d0ed3f7de492a5f4db9d7922c23adbf17ffe74772e26ab45c071ac03
+  data.tar.gz: 8e2f7cd26c99130c1feed4b9907134b9c18cd5d087c7c60b3cf16a7a56483997
 SHA512:
-  metadata.gz: 91d417a156fb4c761264ad623f762a52b2864f0848c38e7ff15d7f467fa26c283d7ab1170fd00b880b177158dfaeafc343264c286a9bcf8cd70c25fd10a19df8
-  data.tar.gz: 38e510e2d4014dc6ccccc71ee97841425e3f55df36b3b673092a0a7101dc5fb019d8b3eb8a4f6692530b933f2ce0d9a6eb99cc679401f573ee017c905521c68e
+  metadata.gz: 4eb47ee8c19bb6eaa3dcecb77f6f23ada53c304470a7dbcf823d620839f085fed9282f6b9c4bff3988a44f303481020ab7fcea6b9b92061597132e650ebd538c
+  data.tar.gz: 6e4b29a3a70ee5fe1531c7e68084c72c799ab58e7e6fe6a49211180e8ca506da38d59971bc143066918f7340fc67ce0f0574ac821892a14ae84242b14767dc1a

data/README.md

@@ -25,9 +25,8 @@ You need to tell RuboCop to load RuboCop Rails Accessibility.
 Put this into your `.rubocop.yml`.
 
 ``` yaml
-inherit_gem:
-  rubocop-rails-accessibility:
-    - config/default.yml
+require:
+  - rubocop-rails-accessibility
 ```
 
 ## Testing
@@ -47,14 +46,14 @@ bundle exec rake
 ## The Cops
 
 All cops are located under
-[`lib/rubocop/cop/rubocop-rails-accessibility`](lib/rubocop/cop/rubocop-rails-accessibility), and contain
+[`lib/rubocop/cop/rails_accessibility`](lib/rubocop/cop/rails_accessibility), and contain
 examples/documentation.
 
 ## Rules
 
-- [RuboCop::Cop::Accessibility::ImageHasAlt](guides/image-has-alt.md)
-- [RuboCop::Cop::Accessibility::NoPositiveTabindex](guides/no-positive-tabindex.md)
-- [RuboCop::Cop::Accessibility::NoRedundantImageAlt](guides/no-redundant-image-alt.md)
+- [RailsAccessibility/ImageHasAlt](guides/image-has-alt.md)
+- [RailsAccessibility/NoPositiveTabindex](guides/no-positive-tabindex.md)
+- [RailsAccessibility/NoRedundantImageAlt](guides/no-redundant-image-alt.md)
 
 ## Contributing
 

data/config/default.yml

@@ -1,15 +1,11 @@
-require:
-  - rubocop/cop/rubocop_rails_accessibility_cops
-
-AllCops:
-  DisabledByDefault: true
-
-RubocopRailsAccessibility/ImageHasAlt:
+RailsAccessibility/ImageHasAlt:
   Enabled: true
   StyleGuide: https://github.com/github/rubocop-rails-accessibility/blob/master/guides/image-has-alt.md
-RubocopRailsAccessibility/NoPositiveTabindex:
+
+RailsAccessibility/NoPositiveTabindex:
   Enabled: true
   StyleGuide: https://github.com/github/rubocop-rails-accessibility/blob/master/guides/no-positive-tabindex.md
-RubocopRailsAccessibility/NoRedundantImageAlt:
+
+RailsAccessibility/NoRedundantImageAlt:
   Enabled: true
   StyleGuide: https://github.com/github/rubocop-rails-accessibility/blob/master/guides/no-redundant-image-alt.md

data/guides/image-has-alt.md

@@ -1,4 +1,4 @@
-# RubocopRailsAccessibility/ImageHasAlt
+# RailsAccessibility/ImageHasAlt
 
 ## Rule Details
 
@@ -26,4 +26,4 @@ Images should have an alt prop with meaningful text or an empty string for decor
 ```erb
 <!-- also good -->
 <%= image_tag "spinners/octocat-spinner-16px.gif", size: "12x12", alt: "" %>
-```
+```

data/guides/no-positive-tabindex.md

@@ -1,4 +1,4 @@
-# RubocopRailsAccessibility/NoPositiveTabindex
+# RailsAccessibility/NoPositiveTabindex
 
 ## Rule Details
 
@@ -21,4 +21,4 @@ Positive tabindex is error-prone and often inaccessible.
 ```erb
 <!-- good -->
 <%= button_tag "Continue", :tabindex => -1 %>
-```
+```

data/guides/no-redundant-image-alt.md

@@ -1,4 +1,4 @@
-# RubocopRailsAccessibility/NoRedundantImageAlt
+# RailsAccessibility/NoRedundantImageAlt
 
 ## Rule Details
 
@@ -21,4 +21,4 @@ Alt prop should not contain `image` or `picture` as screen readers already annou
 ```erb
 <!-- good -->
 <%= image_tag "cat.gif", size: "12x12", alt: "A black cat" %>
-```
+```

data/lib/rubocop/cop/{rubocop-rails-accessibility → rails_accessibility}/image_has_alt.rb

@@ -4,7 +4,7 @@ require "rubocop"
 
 module RuboCop
   module Cop
-    module RubocopRailsAccessibility
+    module RailsAccessibility
       class ImageHasAlt < Base
         MSG = "Images should have an alt prop with meaningful text or an empty string for decorative images"
 

data/lib/rubocop/cop/{rubocop-rails-accessibility → rails_accessibility}/no_positive_tabindex.rb

@@ -4,7 +4,7 @@ require "rubocop"
 
 module RuboCop
   module Cop
-    module RubocopRailsAccessibility
+    module RailsAccessibility
       class NoPositiveTabindex < Base
         MSG = "Positive tabindex is error-prone and often inaccessible."
 

data/lib/rubocop/cop/{rubocop-rails-accessibility → rails_accessibility}/no_redundant_image_alt.rb

@@ -4,7 +4,7 @@ require "rubocop"
 
 module RuboCop
   module Cop
-    module RubocopRailsAccessibility
+    module RailsAccessibility
       class NoRedundantImageAlt < Base
         MSG = "Alt prop should not contain `image` or `picture` as screen readers already announce the element as an image"
         REDUNDANT_ALT_WORDS = %w[image picture].freeze

data/lib/rubocop/rails_accessibility/inject.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+# The original code is from https://github.com/rubocop/rubocop-rspec/blob/main/lib/rubocop/rspec/inject.rb
+# See https://github.com/rubocop/rubocop-rspec/blob/main/MIT-LICENSE.md
+module RuboCop
+  module RailsAccessibility
+    module Inject
+      def self.defaults!
+        path = CONFIG_DEFAULT.to_s
+        hash = ::RuboCop::ConfigLoader.send(:load_yaml_configuration, path)
+        config = ::RuboCop::Config.new(hash, path).tap(&:make_excludes_absolute)
+        puts "configuration from #{path}" if ::RuboCop::ConfigLoader.debug?
+        config = ::RuboCop::ConfigLoader.merge_with_default(config, path)
+        ::RuboCop::ConfigLoader.instance_variable_set(:@default_configuration, config)
+      end
+    end
+  end
+end

data/lib/rubocop/rails_accessibility/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module RailsAccessibility
+    VERSION = "0.2.0"
+  end
+end

data/lib/rubocop/rails_accessibility.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "pathname"
+
+module RuboCop
+  module RailsAccessibility
+    PROJECT_ROOT   = Pathname.new(__dir__).parent.parent.expand_path.freeze
+    CONFIG_DEFAULT = PROJECT_ROOT.join("config", "default.yml").freeze
+  end
+end

data/lib/rubocop-rails-accessibility.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "rubocop"
+require "rubocop/rails_accessibility"
+require "rubocop/rails_accessibility/inject"
+require "rubocop/rails_accessibility/version"
+
+RuboCop::RailsAccessibility::Inject.defaults!
+
+require "rubocop/cop/rails_accessibility/image_has_alt"
+require "rubocop/cop/rails_accessibility/no_positive_tabindex"
+require "rubocop/cop/rails_accessibility/no_redundant_image_alt"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rails-accessibility
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - GitHub Accessibility Team
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2022-09-22 00:00:00.000000000 Z
+date: 2022-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -129,26 +129,20 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rspec"
-- ".rubocop.yml"
-- CODEOWNERS
 - CONTRIBUTING.md
-- Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
-- Rakefile
 - config/default.yml
 - guides/image-has-alt.md
 - guides/no-positive-tabindex.md
 - guides/no-redundant-image-alt.md
-- lib/rubocop/cop/inject.rb
-- lib/rubocop/cop/rubocop-rails-accessibility/image_has_alt.rb
-- lib/rubocop/cop/rubocop-rails-accessibility/no_positive_tabindex.rb
-- lib/rubocop/cop/rubocop-rails-accessibility/no_redundant_image_alt.rb
-- lib/rubocop/cop/rubocop_rails_accessibility_cops.rb
-- lib/rubocop/cop/version.rb
-- rubocop-rails-accessibility.gemspec
+- lib/rubocop-rails-accessibility.rb
+- lib/rubocop/cop/rails_accessibility/image_has_alt.rb
+- lib/rubocop/cop/rails_accessibility/no_positive_tabindex.rb
+- lib/rubocop/cop/rails_accessibility/no_redundant_image_alt.rb
+- lib/rubocop/rails_accessibility.rb
+- lib/rubocop/rails_accessibility/inject.rb
+- lib/rubocop/rails_accessibility/version.rb
 homepage: https://github.com/github/rubocop-rails-accessibility
 licenses:
 - MIT
@@ -175,5 +169,5 @@ requirements: []
 rubygems_version: 3.3.10
 signing_key: 
 specification_version: 4
-summary: Custom extension for RuboCop.
+summary: Custom RuboCop rules for Rails Accessibility.
 test_files: []

data/.rspec

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

data/.rubocop.yml

@@ -1,9 +0,0 @@
-inherit_gem:
-  rubocop-github:
-    - config/default.yml
-    - config/rails.yml
-
-Naming/FileName:
-  Enabled: true
-  Exclude:
-    - "rubocop-rails-accessibility.gemspec"

data/CODEOWNERS

@@ -1 +0,0 @@
-* @github/accessibility-reviewers

data/Gemfile

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in rubocop-rails-accessibility.gemspec
-gemspec

data/Gemfile.lock

@@ -1,108 +0,0 @@
-PATH
-  remote: .
-  specs:
-    rubocop-rails-accessibility (0.1.2)
-      rubocop (>= 1.0.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    actionview (7.0.3.1)
-      activesupport (= 7.0.3.1)
-      builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activesupport (7.0.3.1)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-    ast (2.4.2)
-    builder (3.2.4)
-    concurrent-ruby (1.1.10)
-    crass (1.0.6)
-    diff-lcs (1.5.0)
-    erubi (1.11.0)
-    i18n (1.12.0)
-      concurrent-ruby (~> 1.0)
-    json (2.6.2)
-    loofah (2.18.0)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    minitest (5.16.3)
-    nokogiri (1.13.8-x86_64-darwin)
-      racc (~> 1.4)
-    nokogiri (1.13.8-x86_64-linux)
-      racc (~> 1.4)
-    parallel (1.22.1)
-    parser (3.1.2.0)
-      ast (~> 2.4.1)
-    racc (1.6.0)
-    rack (2.2.4)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.4.3)
-      loofah (~> 2.3)
-    rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.5.0)
-    rexml (3.2.5)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    rubocop (1.31.2)
-      json (~> 2.3)
-      parallel (~> 1.10)
-      parser (>= 3.1.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.18.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.19.1)
-      parser (>= 3.1.1.0)
-    rubocop-github (0.18.0)
-      rubocop (>= 1.0.0)
-      rubocop-performance
-      rubocop-rails
-    rubocop-performance (1.14.3)
-      rubocop (>= 1.7.0, < 2.0)
-      rubocop-ast (>= 0.4.0)
-    rubocop-rails (2.15.2)
-      activesupport (>= 4.2.0)
-      rack (>= 1.1)
-      rubocop (>= 1.7.0, < 2.0)
-    ruby-progressbar (1.11.0)
-    tzinfo (2.0.5)
-      concurrent-ruby (~> 1.0)
-    unicode-display_width (2.2.0)
-
-PLATFORMS
-  x86_64-darwin-19
-  x86_64-linux
-
-DEPENDENCIES
-  actionview
-  minitest
-  rake (~> 13.0)
-  rspec (~> 3.0)
-  rubocop-github
-  rubocop-performance
-  rubocop-rails
-  rubocop-rails-accessibility!
-
-BUNDLED WITH
-   2.3.17

data/Rakefile

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rake/testtask"
-require "rspec/core/rake_task"
-
-Rake::TestTask.new
-
-RSpec::Core::RakeTask.new(:spec)
-
-require "rubocop/rake_task"
-
-RuboCop::RakeTask.new
-
-task default: %i[test rubocop]
-
-desc "Generate a new cop with a template"
-task :new_cop, [:cop] do |_task, args|
-  require "rubocop"
-
-  cop_name = args.fetch(:cop) do
-    warn "usage: bundle exec rake 'new_cop[Department/Name]'"
-    exit!
-  end
-
-  generator = RuboCop::Cop::Generator.new(cop_name)
-
-  generator.write_source
-  generator.write_spec
-  generator.inject_require(root_file_path: "lib/rubocop-rails-accessibility.rb")
-  generator.inject_config(config_file_path: "config/default.yml")
-
-  puts generator.todo
-end

data/lib/rubocop/cop/inject.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-require "rubocop"
-
-# The original code is from https://github.com/rubocop/rubocop-rspec/blob/main/lib/rubocop/rspec/inject.rb
-# See https://github.com/rubocop/rubocop-rspec/blob/main/MIT-LICENSE.md
-module RubocopRailsAccessibility
-  module Inject
-    def self.defaults!
-      path = CONFIG_DEFAULT.to_s
-      hash = ::RuboCop::ConfigLoader.send(:load_yaml_configuration, path)
-      config = ::RuboCop::Config.new(hash, path).tap(&:make_excludes_absolute)
-      puts "configuration from #{path}" if ::RuboCop::ConfigLoader.debug?
-      config = ::RuboCop::ConfigLoader.merge_with_default(config, path)
-      ::RuboCop::ConfigLoader.instance_variable_set(:@default_configuration, config)
-    end
-  end
-end

data/lib/rubocop/cop/rubocop_rails_accessibility_cops.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-require "pathname"
-require "yaml"
-
-require_relative "inject"
-require_relative "version"
-require_relative "rubocop-rails-accessibility/image_has_alt"
-require_relative "rubocop-rails-accessibility/no_positive_tabindex"
-require_relative "rubocop-rails-accessibility/no_redundant_image_alt"

data/lib/rubocop/cop/version.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-module RubocopRailsAccessibility
-  VERSION = "0.1.2"
-end

data/rubocop-rails-accessibility.gemspec

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/rubocop/cop/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "rubocop-rails-accessibility"
-  spec.version = RubocopRailsAccessibility::VERSION
-  spec.authors = ["GitHub Accessibility Team"]
-  spec.email = ["accessibility@github.com"]
-
-  spec.summary = "Custom extension for RuboCop."
-  spec.homepage = "https://github.com/github/rubocop-rails-accessibility"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.7.0"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
-  spec.metadata["rubygems_mfa_required"] = "true"
-
-  spec.add_dependency "rubocop", ">= 1.0.0"
-
-  spec.add_development_dependency "actionview"
-  spec.add_development_dependency "minitest"
-  spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rubocop-github"
-  spec.add_development_dependency "rubocop-rails"
-  spec.add_development_dependency "rubocop-performance"
-
-  # 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 do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-end