gl_rubocop 0.2.6 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc932e911296ebd58c3e59febe32b734287f3ac302762c807c7f2cf58cc1c3ea
-  data.tar.gz: 9e9a20252ffcf744d7c8faf367f53f355e07dfcd9d8cb20f29a7d28401c5fd42
+  metadata.gz: c97906865d188f4a1807b324836b2c20f6dbd5f2cf334f3d50b825f33af1ee54
+  data.tar.gz: 6fa0cd4593fda7e991ce66656e14c9b4170244581a6acf285ea9e396ec27ec04
 SHA512:
-  metadata.gz: c1f6f481ca4275167ba6c630eaf558a83bd29cac26f6a777c8354dd0dff798c792f86eaded520dab8df616294cb6c0941477a2343abc4a13bdfa548bb021e7b7
-  data.tar.gz: 3ef8ba758032a3623ebfe92fbc3cef16b4736b78e0875051ef1f158131f78bbf5b1cb8933ea12c78d4beb103c86d525e3f4ddd607e19d03cc69ea3bc331290d9
+  metadata.gz: 723854e3cea8ca330f0a7a5314a4f8d509ab3fb05892d7d454ad29967e1c8e6b680d7057f10185089369cdb0eb35103ee57d7abdd06fe8dbc8cab78ff0ed9be3
+  data.tar.gz: 373d524cf7c4d8cc8b44d3cb4ec74ad68c25b474bb5782079d1da40ae1ed990fc9cb96c85dae14339cb0df37d427f7a8d80cbe102468add179acfcfc1ec5c3ff

data/README.md

@@ -1,2 +1,56 @@
 # gl_rubocop
+
 A shareable configuration of rules we use at Give Lively to lint our Ruby code.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gl_rubocop', require: false
+```
+
+And then execute:
+
+```bash
+ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+ gem install gl_lint
+```
+
+And finally add this to the top of your project's RuboCop configuration file:
+
+```yml
+ inherit_gem:
+    gl_rubocop: default.yml
+```
+
+Any `Include` or `Exclude` configuration provided will be merged with RuboCop's defaults.
+
+For more information about inheriting configuration from a gem please check
+[RuboCop's
+documentation](https://docs.rubocop.org/rubocop/configuration.html#inheriting-configuration-from-a-dependency-gem).
+
+## Making changes and publishing
+
+1. As per our code agreements, all code changes to this gem are required to be made via pull request with final approval from at least one Give Lively engineer.
+
+2. When creating a pull request, ensure that your code changes include an update to the gem's [version number](https://github.com/givelively/gl_rubocop/blob/main/lib/gl_rubocop/version.rb) using [semantic versioning](https://semver.org/)
+
+3. After getting approval, merge your changes to `main`.
+
+4. Once your CI build finishes sucessfully, pull the latest version of `main` locally.
+
+5. Run the command `gem build`. This bundles the relevant files from the gem and prepares it to be published to [rubygems.org](https://rubygems.org/). (Note: if you are not one of the owners listed you may need to request that that this and the following step be completed by one of the gem owners listed in CODEOWNERS)
+
+6. Once the bundle is successfully created there should be a new file created locally that looks like `gl_rubocop-<new_gem_version_number>.gem`.
+
+7. Run the command `gem push gl_rubocop-<new_gem_version_number>.gem`.
+
+8. Following the authorization prompts listed by the gem command.
+
+9. Your changes have now been published to the rubygems registry.

data/default.yml

@@ -4,6 +4,7 @@ require:
   - rubocop-rspec
   - rubocop-magic_numbers
   - rubocop-haml
+  - rubocop-rake
   - ./lib/gl_rubocop/gl_cops/interactor_inherits_from_interactor_base.rb
   - ./lib/gl_rubocop/gl_cops/callback_method_names.rb
   - ./lib/gl_rubocop/gl_cops/prevent_erb_files.rb
@@ -157,6 +158,11 @@ Rails/FindEach:
 Rails/I18nLocaleTexts:
   Enabled: false
 
+Rails/UnusedIgnoredColumns:
+  # This rule is incompatible with our split schema for datawarehouse models
+  # It is disabled by default in rubocop-rails
+  Enabled: false
+
 Style/GlobalVars:
   Exclude:
     - 'spec/**/*'

data/gl_rubocop.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'rubocop', '~> 1.62.0'
+  spec.add_dependency 'rubocop', '~> 1.62.1'
   spec.add_dependency 'rubocop-haml', '~> 0.2.4'
   spec.add_dependency 'rubocop-magic_numbers'
   spec.add_dependency 'rubocop-performance'

data/lib/gl_rubocop/gl_cops/unique_identifier.rb

@@ -4,10 +4,12 @@ module GLRubocop
       # This cop ensures that view components include a data-test-id attribute.
       #
       # Good:
-      #   {data-test-id: "unique-id"}
+      #   {data-test-id: 'unique-id'}
       #   {data-test-id: @unique_id }
-      #   {'data-test-id': "unique-id"}
+      #   {'data-test-id': 'unique-id'}
       #   {"data-test-id": "unique-id"}
+      #   {data: {test-id: 'unique-id'}}
+      #   {data: {'test-id': 'unique-id'}}
       #
       # Bad:
       #   {data: {testId: "unique-id"}}
@@ -15,7 +17,7 @@ module GLRubocop
 
       MSG = 'View components must include a data-test-id attribute'.freeze
       EMPTY_MSG = 'data-test-id attribute must not be empty'.freeze
-      UNIQUE_IDENTIFIER = 'data-test-id'.freeze
+      UNIQUE_IDENTIFIER = 'test-id'.freeze
 
       def on_send(node)
         return unless file_exists? && valid_method_name?(node)
@@ -42,7 +44,7 @@ module GLRubocop
 
       def regex_for_indentifier_and_value
         key = Regexp.quote(UNIQUE_IDENTIFIER)
-        /(?:#{key}|["']#{key}["']):\s*(["']([^"']*)["']|@\w+)/
+        /(?:["']?data-#{key}["']?|data:.?\{["']?#{key}["']?):\s*(["']([^"']*)["']|@\w+)/
       end
 
       def test_id_value

data/lib/gl_rubocop/version.rb

@@ -1,3 +1,3 @@
 module GLRubocop
-  VERSION = '0.2.6'.freeze
+  VERSION = '0.2.7'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gl_rubocop
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
 platform: ruby
 authors:
 - Give Lively
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-01-17 00:00:00.000000000 Z
+date: 2025-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.62.0
+        version: 1.62.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.62.0
+        version: 1.62.1
 - !ruby/object:Gem::Dependency
   name: rubocop-haml
   requirement: !ruby/object:Gem::Requirement