ruboguide 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2e323fb7829fa6d92391c9cb778f6e1289be1931631afb45a43162d4be223b3a
+  data.tar.gz: 967e7aa1f6888a7052b479aaccd7ac45617ef9c6773f836b8c7948b03b98f223
+SHA512:
+  metadata.gz: 304f82043226cc9f1850cfc34a12b9009c92c82b31a6ab4770789853a34aaba272333542579c931259b45832123c50ed457f70cd7d5d3f8903011f24971de328
+  data.tar.gz: 256ed380e76a7124eba5e4b9817d2ef8632ad4e468f5f678b0c32c6d4c634f2948812e0b3704d6764eaf46bf6fc84eba7c04ea6cf612b8b0ec6c74955b168102

data/.editorconfig

@@ -0,0 +1,13 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false
+

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_from:
+  - styles/rubocop-rails.yml

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,66 @@
+PATH
+  remote: .
+  specs:
+    ruboguide (0.1.0)
+      rubocop (= 1.23.0)
+      rubocop-performance (= 1.12.0)
+      rubocop-rails (= 2.12.4)
+      rubocop-rake (= 0.6.0)
+      rubocop-rspec (= 2.6.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.4.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    concurrent-ruby (1.2.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.17.0)
+    parallel (1.22.1)
+    parser (3.1.3.0)
+      ast (~> 2.4.1)
+    rack (3.0.2)
+    rainbow (3.1.1)
+    regexp_parser (2.6.1)
+    rexml (3.2.5)
+    rubocop (1.23.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.12.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.24.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.12.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rails (2.12.4)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.7.0, < 2.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.6.0)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.3.0)
+
+PLATFORMS
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  ruboguide!
+
+BUNDLED WITH
+   2.4.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Researchable
+
+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,48 @@
+# Ruboguide
+
+Ruboguide is Researchable's gem to standardize rubocop configuration, to achieve a uniform style on all ruby projects.
+
+## Installation
+
+Add the following to your Gemfile:
+```ruby
+gem 'ruboguide', git: 'https://gitlab.com/researchable/general/gems/ruboguide'
+```
+
+If you already have rubocop installed, remove it. This gem already installs rubocop for you (and ensures all projects
+use the same version of rubocop).
+
+Edit your `rubocop.yml` to include the following:
+
+```yaml
+inherit_gem:
+  ruboguide:
+    - styles/rubocop.yml
+```
+
+If your project is a rails project you should instead add:
+```yaml
+inherit_gem:
+  ruboguide:
+    - styles/rubocop-rails.yml
+```
+
+## Usage
+
+This gem gives you rubocop. To lint your codebase, call it the way you normally would e.g.:
+```shell
+rubocop -a
+```
+
+To run linting on CI using this gem, you can use the CI template available on the 
+[templates/gitlab/base](https://gitlab.com/researchable/general/templates/gitlab/base/-/tree/master/ruby) repository
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/ruboguide/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Ruboguide
+  VERSION = '1.0.0'
+end

data/lib/ruboguide.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative 'ruboguide/version'
+
+module Ruboguide
+  class Error < StandardError; end
+end

data/sig/ruboguide.rbs

@@ -0,0 +1,4 @@
+module Ruboguide
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/styles/rubocop-rails.yml

@@ -0,0 +1,26 @@
+require:
+  - rubocop-rails
+
+inherit_from:
+  - rubocop.yml
+
+# This actually breaks some SQL queries:
+Rails/PluckInWhere:
+  Enabled: false
+
+# We call use cases from the console so we want to see output
+Rails/Output:
+  Exclude:
+    - 'app/use_cases/**/*'
+
+# The generators are designed to evaluate questionnaire contents as HTML.
+Rails/OutputSafety:
+  Exclude:
+    - 'app/generators/**/*'
+
+# We think it's okay to use instance variables in helper classes. We may choose to refactor these
+# and remove this assertion at a later date.
+Rails/HelperInstanceVariable:
+  Exclude:
+    - 'app/helpers/**/*'
+

data/styles/rubocop.yml

@@ -0,0 +1,114 @@
+require:
+  - rubocop-performance
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.0
+  Exclude:
+    - 'config/**/*'
+    - 'db/**/*'
+    - 'node_modules/**/*'
+    - 'script/**/*'
+    - 'tmp/**/*'
+    - 'vendor/**/*'
+    - 'Guardfile'
+    - 'bin/*'
+    - 'node_modules/**/*'
+
+# Use UTF-8 as the source file encoding.
+Style/Encoding:
+  Enabled: false
+
+Style/HashEachMethods:
+  Enabled: false
+
+Style/HashTransformKeys:
+  Enabled: false
+
+Style/HashTransformValues:
+  Enabled: false
+
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+
+Style/RedundantRegexpEscape:
+  Enabled: true
+
+Style/RedundantFetchBlock:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+
+# Limit lines to 80 characters.
+Layout/LineLength:
+  Max: 120
+  IgnoredPatterns: ['\A#']
+
+Layout/EndOfLine:
+  EnforcedStyle: lf
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+
+
+# Default is 5
+Metrics/ParameterLists:
+  Max: 6
+
+# Avoid methods longer than 10 lines of code
+Metrics/MethodLength:
+  CountComments: false  # count full line comments?
+  Max: 20
+
+# Limit modules to have a length of 768
+Metrics/ModuleLength:
+  Max: 768
+  Exclude:
+    - 'spec/**/*'
+
+# Describe specs fail this test
+# Namespaces in rake tasks do too
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - '**/*.rake'
+    - '**/*.gemspec'
+
+# Limit classes to have a length of 768
+Metrics/ClassLength:
+  Max: 768
+
+Metrics/AbcSize:
+  Exclude:
+    - 'spec/**/*'
+
+################################################################## DISABLED COPS
+# These cops are disabled because we think they are a Bad Idea. If you add one
+# here, make sure to add a comment describing what the cop does, and why this
+# is a bad idea.
+
+# Forces the argument names of the block given to #reduce to be `a, e`. Only
+# applies on single-line blocks, but why would we want to force people to use
+# less descriptive names?
+Style/Documentation:
+  Enabled: true
+
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/SlicingWithRange:
+  Enabled: true

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: ruboguide
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Researchable
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-03-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.23.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.23.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.12.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.12.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.12.4
+- !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.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+description: Ruboguide is all you need to add rubocop to your project. It standardizes
+  the rubocop version and the cops configurations.
+email:
+- info@researchable.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- lib/ruboguide.rb
+- lib/ruboguide/version.rb
+- sig/ruboguide.rbs
+- styles/rubocop-rails.yml
+- styles/rubocop.yml
+homepage: http://researchable.nl
+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: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: Researchable's rubocop style guide
+test_files: []