boxt_rubocop 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7c3a40b7d0af85cb456f3e5a369b0e7086f083b68ee31dc8bc2b5c5a0a0321d2
+  data.tar.gz: 3588bd96d35b7f50e60e7c169e847a292c645f7236b425962d1a6aa807ac5bab
+SHA512:
+  metadata.gz: 1f13c650457c551de7d2605ed135bb22a4b4f7d7f9df9915ec8f8f3aa027144fd2a219cdfbe53fcc48904056cad0750fb3fa25bd1244d04de716b978711d97d7
+  data.tar.gz: 25468f95d36ea24411aaf46e8b1fd1b3b03ad557b5c7ef00bec33c6b00563a7e8107f5f9bf4589842865d37933c9f09558ad35c80fc58c8d0405196ca5d315e6

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2022 Boxt
+
+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,91 @@
+# BOXT Rubocop
+
+[![Gem Version](https://badge.fury.io/rb/boxt_rubocop.svg)](https://badge.fury.io/rb/boxt_rubocop)
+[![CI](https://github.com/boxt/boxt_rubocop/actions/workflows/ci.yml/badge.svg)](https://github.com/boxt/boxt_rubocop/actions/workflows/ci.yml)
+
+Base [Rubocop](https://rubocop.org) settings for all Boxt Ruby projects.
+
+## Requirements
+
+* Ruby >= 2.7
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :development, :test do
+  # ...
+  gem "boxt_rubocop"
+end
+```
+
+And then execute:
+
+```sh
+bundle
+```
+
+## Usage
+
+Add a `.rubocop.yml` file to the root of your project with the following settings:
+
+```yml
+inherit_gem:
+  boxt_rubocop:
+    - default.yml # use default cops
+    - rails.yml # use Rails cops - see Additional Extensions/Cops
+    - rspec.yml # use rspec cops - see Additional Extensions/Cops
+```
+
+### NewCops
+
+`NewCops` is enabled by default.
+
+### Additional Extensions/Cops
+
+The following Rubocop gems are also installed with this gem:
+
+* [rubocop-faker](https://github.com/koic/rubocop-faker)
+* [rubocop-rails](https://github.com/rubocop-hq/rubocop-rails)
+* [rubocop-rake](https://github.com/rubocop-hq/rubocop-rake)
+* [rubocop-rspec](https://github.com/rubocop-hq/rubocop-rspec)
+
+To enable these add the following to your `.rubocop.yml` file.
+
+```yml
+inherit_gem:
+  boxt_rubocop:
+  # .... add cops
+
+require:
+  - rubocop-faker # if your project is using the Faker gem then add this
+  - rubocop-rails # if your project is a Rails app/engine then add this, plus the - rails.yml setting above
+  - rubocop-rake # if your project is using rake then add this
+  - rubocop-rspec # if your project is using rspec then add this, plus the - rspec.yml setting above
+```
+
+## Editor Plugins
+
+There are also some useful Rubocop editor plugins to help with in-editor linting.
+
+### Atom
+
+- [linter-rubocop](https://atom.io/packages/linter-rubocop)
+- [rubocop-auto-correct](https://atom.io/packages/rubocop-auto-correct)
+
+### RubyMine
+
+- [rubocop](https://www.jetbrains.com/help/ruby/rubocop.html)
+
+### VSCode
+
+- [ruby-rubocop](https://marketplace.visualstudio.com/items?itemName=misogi.ruby-rubocop)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/boxt/boxt_rubocop.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = Dir.glob("spec/**/*_spec.rb")
+end
+
+desc "Map rake test to rake spec"
+task test: :spec

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/default.yml

@@ -0,0 +1,43 @@
+AllCops:
+  Exclude:
+    - "**/*/schema.rb"
+    - Gemfile.lock
+    - node_modules/**/*
+    - tmp/**/*
+    - vendor/**/*
+  NewCops: enable
+Layout/ClassStructure:
+  Enabled: true
+Layout/LineLength:
+  Exclude:
+    - config/routes.rb
+    - config/routes/*
+  Max: 120
+Metrics/AbcSize:
+  Exclude:
+    - db/migrate/**/*
+Metrics/BlockLength:
+  Exclude:
+    - "*.gemspec"
+    - Gemfile
+    - config/routes.rb
+    - config/routes/*
+    - db/migrate/**/*
+    - spec/**/*
+    - test/**/*
+Metrics/ClassLength:
+  Exclude:
+    - db/migrate/**/*
+    - spec/**/*
+    - test/**/*
+Metrics/MethodLength:
+  Exclude:
+    - db/migrate/**/*
+    - spec/**/*
+    - test/**/*
+Style/Documentation:
+  Enabled: false
+Style/DoubleNegation:
+  Enabled: false
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/lib/boxt_rubocop/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module BoxtRubocop
+  VERSION = File.read("VERSION").split("\n").first
+end

data/lib/boxt_rubocop.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "boxt_rubocop/version"
+
+module BoxtRubocop
+  module_function
+
+  ##
+  # Provide a root path helper for the gem root dir
+  #
+  # Returns Pathname
+  def root
+    Pathname.new(File.dirname(__dir__))
+  end
+end

data/rails.yml

@@ -0,0 +1,20 @@
+Rails/ApplicationController:
+  Exclude:
+    - spec/**/*
+    - test/**/*
+Rails/EnvironmentVariableAccess:
+  AllowReads: true # Enabling allow reads so we can use ENV["VAR"]
+Rails/SkipsModelValidations:
+  Exclude:
+    - db/migrate/**/*
+    - lib/tasks/**/*
+    - spec/**/*
+    - test/**/*
+Rails/UnknownEnv:
+  Environments:
+    - cucumber
+    - development
+    - production
+    - qa
+    - test
+    - uat

data/rspec.yml

@@ -0,0 +1,12 @@
+# Excluding as we set up the rake specs as 'describe "rake namespace:task", type: :task do' which determines what task
+# is being tested, and this cop doesn't like having a describe block without a class or module name.
+RSpec/DescribeClass:
+  Exclude:
+    - spec/tasks/**/*
+# This is to prevent Rubocop from bugging on a spec helper that doesn't contain an example, which the support ones don't
+RSpec/LeadingSubject:
+  Exclude:
+    - spec/support
+# Allow there to be a max of 4 example groups deep in Rspec tests
+RSpec/NestedGroups:
+  Max: 4

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: boxt_rubocop
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Boxt
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.26.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.26.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.14.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.14.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+description: Base Rubocop settings for all Boxt Ruby projects
+email:
+- developers@boxt.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- VERSION
+- default.yml
+- lib/boxt_rubocop.rb
+- lib/boxt_rubocop/version.rb
+- rails.yml
+- rspec.yml
+homepage: https://github.com/boxt/boxt_rubocop
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Base Rubocop settings for all Boxt Ruby projects
+test_files: []