erblint-github 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 819c1bde423300648fdae7afee85bab8306b8ed234eaf04f1318d8a18abd380a
+  data.tar.gz: 16217f106609dde5113989809bd17fd6984ac170485222c8956460255cf514bb
+SHA512:
+  metadata.gz: 355ff2fc38afdf3f426c80da3cada076565f1b69e4ff0ca20f909bd0dacec0a7fb8b4f61c03a8701325cf5f96b95480877b4057d65d232f856a3f89325408a37
+  data.tar.gz: 955cda7b4f36d4c08755ed23718173bbe910a694de9763b806c15d35a312c01696d1d5c93ca61f4f415680b3cb787debf79464e452a3eb4dd5ede09462324080

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 GitHub
+
+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

@@ -0,0 +1,35 @@
+# erblint-github
+Template style checking for GitHub's Ruby projects
+
+## Setup
+
+1. Update your `Gemfile` and run `bundle install`
+
+``` ruby
+gem "erb_lint", require: false
+gem "erblint-github"
+```
+
+2. Require the linters within the `.erb-linters` folder. This could be done by adding a file `.erb-linters/erblint-github.rb` with the following line.
+
+```ruby
+require "erblint-github/linters"
+```
+
+3. Update the `erb-lint.yml` to configure the rule.
+
+### .erb-lint.yml
+
+```yaml 
+---
+linters:
+  GitHub::Accessibility::NoRedundantImageAlt:
+    enabled: true
+```
+
+## Testing
+
+```
+bundle install
+bundle exec rake test
+```

data/lib/erblint-github/linters/custom_helpers.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "json"
+require "openssl"
+
+module ERBLint
+  module Linters
+    module CustomHelpers
+      def rule_disabled?(processed_source)
+        processed_source.parser.ast.descendants(:erb).each do |node|
+          indicator_node, _, code_node, = *node
+          indicator = indicator_node&.loc&.source
+          comment = code_node&.loc&.source&.strip
+          rule_name = self.class.name.match(/:?:?(\w+)\Z/)[1]
+
+          if indicator == "#" && comment.start_with?("erblint:disable") && comment.match(rule_name)
+            if @offenses.any?
+              clear_offenses
+            else
+              add_offense(processed_source.to_source_range(code_node.loc),
+                          "Unused erblint:disable comment for #{rule_name}")
+            end
+          end
+        end
+      end
+
+      def generate_offense(klass, processed_source, tag, message = nil, replacement = nil)
+        message ||= klass::MESSAGE
+        klass_name = klass.name.demodulize
+        offense = ["#{klass_name}:#{message}", tag.node.loc.source].join("\n")
+        add_offense(processed_source.to_source_range(tag.loc), offense, replacement)
+      end
+
+      def possible_attribute_values(tag, attr_name)
+        value = tag.attributes[attr_name]&.value || nil
+        basic_conditional_code_check(value || "") || [value].compact
+      end
+
+      # Map possible values from condition
+      def basic_conditional_code_check(code)
+        conditional_match = code.match(/["'](.+)["']\sif|unless\s.+/) || code.match(/.+\s?\s["'](.+)["']\s:\s["'](.+)["']/)
+        [conditional_match[1], conditional_match[2]].compact if conditional_match
+      end
+
+      def tags(processed_source)
+        processed_source.parser.nodes_with_type(:tag).map { |tag_node| BetterHtml::Tree::Tag.from_node(tag_node) }
+      end
+    end
+  end
+end

data/lib/erblint-github/linters/github/accessibility/no_redundant_image_alt.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "../../custom_helpers"
+
+module ERBLint
+  module Linters
+    module GitHub
+      module Accessibility
+        class NoRedundantImageAlt < Linter
+          include ERBLint::Linters::CustomHelpers
+          include LinterRegistry
+
+          MESSAGE = "<img> 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
+
+          def run(processed_source)
+            tags(processed_source).each do |tag|
+              next if tag.name != "img"
+              next if tag.closing?
+
+              alt = possible_attribute_values(tag, "alt").join
+              next if alt.empty?
+
+              generate_offense(self.class, processed_source, tag) if (alt.downcase.split & REDUNDANT_ALT_WORDS).any?
+            end
+
+            rule_disabled?(processed_source)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/erblint-github/linters.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+Dir[File.join(__dir__, "linters", "github/**/*.rb")].sort.each { |file| require file }

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: erblint-github
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- GitHub Open Source
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: erb_lint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.13.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-github
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+description: Template style checking for GitHub Ruby repositories
+email:
+- opensource+erblint-github@github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/erblint-github/linters.rb
+- lib/erblint-github/linters/custom_helpers.rb
+- lib/erblint-github/linters/github/accessibility/no_redundant_image_alt.rb
+homepage: https://github.com/github/erblint-github
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: erblint GitHub
+test_files: []