dvla-lint 1.7.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 72c31e71d99c27af1ab416f1fa695286693b16f5459ad824ad2d5e5d7065d34e
+  data.tar.gz: ea7aa626fc01401f918ae488dfadf21996ec7ea1e70987f7723f32d91eafe5eb
+SHA512:
+  metadata.gz: 94c1f886033f02968f2c2841ac8c8336e70a8ac2aaf93f6365a7f79041ce86eabb5526edbbc2aace81ffbf5315440ad6a10d27af9b55746a386a26cd70a1a837
+  data.tar.gz: 0f74671106a74c8cd8a46c4f9a630cb3a4a7a7c0dd68471252e97e15dc4616642ab7d946e2927d603174d9a1c841211862472491a8cda0a9018733d4b4df277b

data/.github/workflows/gem-push.yml

@@ -0,0 +1,48 @@
+name: Ruby Gem Publish
+
+on:
+  push:
+    branches: [ "main" ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: [ '3.0', '3.1', '3.2' ]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Run tests
+        run: bundle exec rspec
+
+  deploy:
+    needs: test
+    runs-on: ubuntu-latest
+    permissions:
+      packages: write
+      contents: read
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby 3.2.2
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.2.2
+          bundler-cache: true
+
+      - name: Publish to RubyGems
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push *.gem
+        env:
+          GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.github/workflows/gem-test.yml

@@ -0,0 +1,22 @@
+name: Ruby Test
+
+on:
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: [ '3.0', '3.1', '3.2' ]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Run tests
+        run: bundle exec rspec

data/.gitignore

@@ -0,0 +1,19 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/
+*.iml
+
+# rspec failure tracking
+.rspec_status
+
+.DS_Store
+
+dvla-lint*gem
+
+Gemfile.lock

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,26 @@
+AllCops:
+  DisplayCopNames:
+    Description: 'Display cop names in offense messages'
+    Enabled: true
+
+  ExtraDetails:
+    Description: 'Display extra details in offense messages.'
+    Enabled: true
+
+  DisplayStyleGuide:
+    Description: 'Display style guide URLs in offense messages.'
+    Enabled: true
+
+require: 
+  - rubocop-rails
+  - rubocop-performance
+
+inherit_from:
+  - rules/dvla-ruby-styleguide.yml
+  - rules/other-lint.yml
+  - rules/other-rails.yml
+  - rules/other-style.yml
+  - rules/other-metrics.yml
+  - rules/other-excludes.yml
+  - rules/other-gemspec.yml
+  - rules/other-security.yml

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 HM Government (Driver and Vehicle Licensing Agency)
+
+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,32 @@
+# DVLA::Lint
+
+This Gem contains the official DVLA Ruby linting rules for all of the Agency's Ruby-based work. It's a fork of the GDS rules contained in GOVUK-Lint (as of commit [0d2d442
+](https://github.com/alphagov/govuk-lint/commit/0d2d4423703f4975e63768a75095e3b989f02d21)) repackaged without with Sass or CLI components and updated to DVLA's house style.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dvla-lint", "~> <major_version>.<minor_version>'
+```
+
+And then execute:
+
+```shell
+bundle
+```
+
+Or install it yourself as:
+
+```shell
+gem install dvla-lint
+```
+
+## Usage
+
+With the gem added to your Gemfile and installed, execute this to install the default DVLA Rubocop configuration in your current directory:
+
+```shell
+bundle exec dvla-lint init
+```

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

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

@@ -0,0 +1,8 @@
+#!/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/dvla-lint.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dvla/lint/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'dvla-lint'
+  spec.version       = Dvla::Lint::VERSION
+  spec.authors       = ['Driver and Vehicle Licensing Agency (DVLA)', 'Nigel Brookes-Thomas']
+  spec.email         = ['nigel.brookes-thomas@dvla.gov.uk']
+
+  spec.summary       = 'Rubocop standard rules'
+  spec.description   = 'The standard Rubocop rules for the DVLA'
+  spec.homepage      = 'https://github.com/dvla/dvla-lint-ruby'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+
+  # 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 = %w[lib]
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'pry', '~> 0.12'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+
+  spec.add_runtime_dependency 'rubocop', '~> 1.44'
+  spec.add_runtime_dependency 'rubocop-performance', '~> 1.5'
+  spec.add_runtime_dependency 'rubocop-rails', '~> 2.17'
+  spec.add_runtime_dependency 'tty-config', '~> 0.5'
+  spec.add_runtime_dependency 'tty-prompt', '~> 0.23'
+end

data/exe/dvla-lint

@@ -0,0 +1,66 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'tty-config'
+require 'tty-prompt'
+
+def prompt
+  @prompt ||= TTY::Prompt.new
+end
+
+def config
+  unless @config
+    @config ||= TTY::Config.new do |c|
+      c.filename = '.rubocop'
+      c.set(:inherit_gem, :'dvla-lint', value: '.rubocop.yml')
+    end
+  end
+  @config
+end
+
+def create_file
+  prompt_text = 'Which type of project are you building?'
+  choices = [
+    'Plain old Ruby files',
+    'Functional tests with Cucumber',
+    'Ruby on Rails project',
+  ]
+  choice = prompt.select(prompt_text, choices)
+  config.set(:Rails, :Enabled, value: true) if choice == choices[2] # Rails
+  config.write(force: true)
+  puts 'Done'
+end
+
+def config_file_exists
+  prompt_text = 'WARNING: you already have a rubocop configuration, ' \
+                "do you want to overwrite it with the DVLA rubocop configuration?\n" \
+                "(#{file_name})"
+  create_file if prompt.yes?(prompt_text)
+end
+
+def config_file_new
+  prompt_text = "Do you want to install the default DVLA rubocop configuration?\n" \
+                "(#{file_name})"
+  create_file if prompt.yes?(prompt_text)
+end
+
+def file_name
+  File.join(Dir.pwd, '.rubocop.yml')
+end
+
+def create_config
+  if File.exist?(file_name)
+    config_file_exists
+  else
+    config_file_new
+  end
+end
+
+if ARGV[0]&.strip.eql? 'init'
+  create_config
+else
+  puts <<~USAGE
+    Usage:
+      dvla-lint init           # create or overwrite a default Rubocop configuration
+  USAGE
+end

data/lib/dvla/lint/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Dvla
+  module Lint
+    VERSION = '1.7.1'
+  end
+end

data/lib/dvla/lint.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'dvla/lint/version'
+
+module Dvla # :nodoc:
+  # This is the wrapper module for the DVLA-Linting rules.
+  # There is nothing in here other than the version number,
+  # with the rules themselves in the /rules directory and loaded
+  # by the .rubocop.yml at this gem's root.
+  module Lint
+    # There's nothing to see here
+  end
+end