rubocop-treatwell 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bcd13a2fb4af356b3d33e9ed7fc5bd93e028d0cec19ace9520e062059141a394
+  data.tar.gz: dcb685ec0fe02ec15b864ec633eb396253a37011d121b71484ae13e82678deca
+SHA512:
+  metadata.gz: 9d2efdea6c0c5414dad6e97c20ebabf1d4c6f3d9b6adc3bffb9e0b7be667d204481be66aab622ff576f1732dbe988f34a90a5c5b7cf12017de89b333988ee342
+  data.tar.gz: dace67517344e59cfa042d9529ca95fbf06411e095dacb9ea432bea290f2245eedca6ff5c67886a8f133b9e1e85285d1d1815768685b8fd31faf2d7fcc111413

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,19 @@
+inherit_from:
+  - rubocop-treatwell-style.yml
+
+AllCops:
+  NewCops: enable
+
+# Is not a rails project
+Rails:
+  Enabled: false
+
+Naming/FileName:
+ Exclude:
+   - lib/rubocop-treatwell.rb
+
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/rubocop/treatwell.rb'

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rubocop-treatwell.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,90 @@
+PATH
+  remote: .
+  specs:
+    rubocop-treatwell (0.1.0)
+      rubocop (~> 1.50.0)
+      rubocop-checkstyle_formatter (~> 0.6.0)
+      rubocop-performance (~> 1.17.0)
+      rubocop-rails (~> 2.19.0)
+      rubocop-rspec (~> 2.22.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.5)
+      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.2)
+    diff-lcs (1.5.0)
+    i18n (1.14.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    minitest (5.18.0)
+    parallel (1.23.0)
+    parser (3.2.2.1)
+      ast (~> 2.4.1)
+    rack (3.0.7)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.50.2)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.18.0)
+      rubocop (~> 1.41)
+    rubocop-checkstyle_formatter (0.6.0)
+      rubocop (>= 1.14.0)
+    rubocop-factory_bot (2.23.1)
+      rubocop (~> 1.33)
+    rubocop-performance (1.17.1)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rails (2.19.1)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.33.0, < 2.0)
+    rubocop-rspec (2.22.0)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+    ruby-progressbar (1.13.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop-treatwell!
+
+BUNDLED WITH
+   2.3.26

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Treatwell
+
+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,60 @@
+<div align="center">
+    
+#### A Ruby style guide by
+
+[![](https://cdn1.treatwell.net/images/view/v2.i1756348.w200.h50.x4965194E.jpeg)](https://treatwell.com/tech)
+
+</div>
+
+# Introduction
+
+This style guide make use of [Relaxed Ruby Style](https://relaxed.ruby.style/), adding customizations used in Treatwell's Ruby projects.
+
+# Usage
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rubocop-treatwell'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rubocop-treatwell
+
+## Usage
+
+Add the following to the top of your `.rubocop.yml`:
+
+```yaml
+inherit_gem:
+  rubocop-treatwell: rubocop-treatwell-style.yml
+```
+
+And run:
+
+```bash
+bundle exec rubocop
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+
+To add a new cop, run `bundle exec rake 'new_cop[Foobar/SuperCoolCopName]'`
+
+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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+### Testing
+
+You can execute a smoke test with `bundle exec rspec`. Check it is success before open a pull request.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/treatwell/rubocop-treatwell.

data/Rakefile

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+desc 'Generate a new cop with a template'
+task :new_cop, [:cop] do |_task, args|
+  require 'rubocop'
+
+  cop_name = args.fetch(:cop) do
+    warn 'usage: bundle exec rake new_cop[Department/Name]'
+    exit!
+  end
+
+  generator = RuboCop::Cop::Generator.new(cop_name)
+
+  generator.write_source
+  generator.write_spec
+  generator.inject_require(root_file_path: 'lib/rubocop/cop/treatwell_cops.rb')
+  generator.inject_config(config_file_path: 'config/default.yml')
+
+  puts generator.todo
+end

data/config/default.yml

@@ -0,0 +1,5 @@
+Rails/UnscopedOverNonModelConstant:
+  Description: 'Identifies calls to `unscoped` over non model constants.'
+  Enabled: pending
+  VersionAdded: '0.1.0'
+  AllowedMethods: []

data/lib/rubocop/cop/rails/unscoped_over_non_model_constant.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # Identifies calls to `unscoped` over non model constants. This can be an issue because
+      # `unscoped` removes all scopes defined before. Calling it directly to the model, it
+      # can be considered as safe because only `default_scope` will be removed, which is the
+      # main reason to use `unscoped` statement.
+      #
+      # @example
+      #   # bad
+      #   User.where(trashed: true).unscoped.first
+      #   User.trashed.unscoped.joins(:posts).where(posts: { trashed: true, title: 'Rails' }).first
+      #   User.joins(:posts).where(posts: { trashed: true, title: 'Rails' }).unscoped.first
+      #
+      #   # good
+      #   User.unscoped.where(trashed: true)
+      #   User.unscoped.joins(:posts).where(posts: { trashed: true, title: 'Rails' })
+      class UnscopedOverNonModelConstant < Base
+        MSG = 'Prevent usage of `unscoped` over non model constants.'
+        RESTRICT_ON_SEND = %i[unscoped].freeze
+
+        def_node_matcher :unscoped_call?, <<~PATTERN
+          (send _ :unscoped $...)
+        PATTERN
+
+        def on_send(node)
+          return if node.receiver.respond_to?(:method_name) && _allowed_methods.include?(node.receiver.method_name.to_s)
+
+          unscoped_call?(node) do
+            next unless _unscoped_on_non_const?(node)
+
+            range = node.loc.selector.with(end_pos: node.loc.expression.end_pos)
+
+            add_offense(range)
+          end
+        end
+
+        private
+
+        def _unscoped_on_non_const?(node)
+          !node.receiver.const_type?
+        end
+
+        def _allowed_methods
+          cop_config['AllowedMethods'] || []
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/treatwell_cops.rb

@@ -0,0 +1,2 @@
+# frozen_string_literal: true
+require_relative 'rails/unscoped_over_non_model_constant'

data/lib/rubocop/treatwell/inject.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# The original code is from https://github.com/rubocop/rubocop-rspec/blob/master/lib/rubocop/rspec/inject.rb
+# See https://github.com/rubocop/rubocop-rspec/blob/master/MIT-LICENSE.md
+module RuboCop
+  module Treatwell
+    # Because RuboCop doesn't yet support plugins, we have to monkey patch in a
+    # bit of our configuration.
+    module Inject
+      def self.defaults!
+        path = CONFIG_DEFAULT.to_s
+        hash = ConfigLoader.send(:load_yaml_configuration, path)
+        config = Config.new(hash, path).tap(&:make_excludes_absolute)
+        puts "configuration from #{path}" if ConfigLoader.debug?
+        config = ConfigLoader.merge_with_default(config, path)
+        ConfigLoader.instance_variable_set(:@default_configuration, config)
+      end
+    end
+  end
+end

data/lib/rubocop/treatwell/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Treatwell
+    VERSION = "0.1.0"
+  end
+end

data/lib/rubocop/treatwell.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "treatwell/version"
+
+module RuboCop
+  module Treatwell
+    class Error < StandardError; end
+    # Your code goes here...
+    PROJECT_ROOT   = Pathname.new(__dir__).parent.parent.expand_path.freeze
+    CONFIG_DEFAULT = PROJECT_ROOT.join('config', 'default.yml').freeze
+    CONFIG         = YAML.safe_load(CONFIG_DEFAULT.read).freeze
+
+    private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
+  end
+end

data/lib/rubocop-treatwell.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+require_relative 'rubocop/treatwell'
+require_relative 'rubocop/treatwell/version'
+require_relative 'rubocop/treatwell/inject'
+
+RuboCop::Treatwell::Inject.defaults!
+
+require_relative 'rubocop/cop/treatwell_cops'

data/rubocop-treatwell-style.yml

@@ -0,0 +1,147 @@
+# This file will inherit from default rubocop config located at
+# https://github.com/rubocop/rubocop/blob/master/config/default.yml
+# and other default config from gems, like rubocop-rails, rubocop-rspec, etc.
+# Some of the default rules are not meant/compatible for monorepo structure
+# especially if you run rubocop on the whole repo, so we need to override them.
+# e.g. default config has a global exclusion list for stuff located in root folder
+#
+# Exclude: Exclude:
+#    - 'node_modules/**/*'
+#    - 'tmp/**/*'
+#
+# This is not appliable for monorepo structure, if you run rubocop from the root
+# folder it will try to analyze stuff in <app>/tmp, while when run in <app> folder
+# it works as intended. We need to tweak include/exclude using better glob patterns
+# (e.g. **/tmp/**/*). Also never use relative paths in Include/Exclude, rules, always use
+# '**/bin/**/*' instead of './bin/**/*' to avoid issues with working directory when runnint it.
+
+inherit_from:
+  - https://relaxed.ruby.style/rubocop.yml
+
+require:
+  - rubocop-performance
+  - rubocop-rspec
+  - rubocop-rails
+  - rubocop-treatwell
+
+AllCops:
+  NewCops: enable
+  Exclude:
+    - '**/bin/*'
+    - '**/db/schema.rb'
+
+  # Ignore symlinks
+  <% Dir['../**/*'].each do |dir| %>
+    <% next unless File.symlink?(dir) %>
+    - <%= File.directory?(dir) ? "#{dir}/**/*" : dir %>
+  <% end %>
+  SuggestExtensions:
+    rubocop-rake: false
+
+Bundler/OrderedGems:
+  Exclude:
+    - '**/Gemfile'
+
+Layout/CaseIndentation:
+  EnforcedStyle: end
+
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: start_of_line
+
+Layout/ExtraSpacing:
+  Exclude:
+    - '**/config/routes.rb'
+
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/HashAlignment:
+  EnforcedColonStyle:
+    - key
+    - table
+  EnforcedHashRocketStyle:
+    - key
+    - table
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/SpaceBeforeFirstArg:
+  Exclude:
+    - '**/config/routes.rb'
+
+Layout/SpaceInsideParens:
+  EnforcedStyle: no_space
+
+Layout/TrailingEmptyLines:
+  Enabled: true
+
+Lint/AmbiguousBlockAssociation:
+  AllowedMethods:
+    - change
+    - not_change
+    - have_enqueued_job
+    - with
+    - once
+
+Lint/UnusedMethodArgument:
+  AllowUnusedKeywordArguments: true
+
+Metrics/BlockLength:
+  Exclude:
+    - '**/config/routes.rb'
+
+Metrics/MethodLength:
+  Max: 80
+
+Metrics/ParameterLists:
+  Max: 8
+
+Naming/MethodParameterName:
+  AllowedNames: io, id, to, by, on, in, at, ip, db, as
+
+Rails/WhereExists:
+  EnforcedStyle: where
+
+Rails/SkipsModelValidations:
+  Exclude:
+    - '**/db/main/migrate/**/*'
+    - '**/spec/**/*'
+
+RSpec/ExampleLength:
+  Max: 20
+
+RSpec/MultipleMemoizedHelpers:
+  Max: 10
+
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/NamedSubject:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Max: 5
+
+RSpec/StubbedMock:
+  Enabled: false
+
+Style/AsciiComments:
+  AllowedChars:
+    - '€'
+
+Style/FormatStringToken:
+  Exclude:
+    - '**/config/routes.rb'
+
+Style/HashSyntax:
+  EnforcedShorthandSyntax: never
+
+Style/PreferredHashMethods:
+  EnforcedStyle: 'verbose'
+
+Style/RescueStandardError:
+  EnforcedStyle: 'implicit'

data/rubocop-treatwell.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "lib/rubocop/treatwell/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "rubocop-treatwell"
+  spec.version = RuboCop::Treatwell::VERSION
+  spec.authors = ["Treatwell Team"]
+  spec.email = ["info@treatwell.com"]
+
+  spec.summary = "Shared style guide for Treatwell Ruby projects"
+  spec.description = "Treatwell::RubyStyle provides a set of shared style guide used across all Treatwell Ruby projects"
+  spec.homepage = "https://github.com/treatwell/ruby-style"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  spec.metadata['rubygems_mfa_required'] = "true"
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # These dependencies are included in all applications
+  spec.add_runtime_dependency 'rubocop', '~> 1.50.0'
+  spec.add_runtime_dependency 'rubocop-checkstyle_formatter', '~> 0.6.0'
+  spec.add_runtime_dependency 'rubocop-performance', '~> 1.17.0'
+  spec.add_runtime_dependency 'rubocop-rails', '~> 2.19.0'
+  spec.add_runtime_dependency 'rubocop-rspec', '~> 2.22.0'
+end

data/sig/rubocop/treatwell.rbs

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

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-treatwell
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Treatwell Team
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-06-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.50.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.50.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-checkstyle_formatter
+  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-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.17.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.17.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.19.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.19.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.22.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.22.0
+description: Treatwell::RubyStyle provides a set of shared style guide used across
+  all Treatwell Ruby projects
+email:
+- info@treatwell.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- config/default.yml
+- lib/rubocop-treatwell.rb
+- lib/rubocop/cop/rails/unscoped_over_non_model_constant.rb
+- lib/rubocop/cop/treatwell_cops.rb
+- lib/rubocop/treatwell.rb
+- lib/rubocop/treatwell/inject.rb
+- lib/rubocop/treatwell/version.rb
+- rubocop-treatwell-style.yml
+- rubocop-treatwell.gemspec
+- sig/rubocop/treatwell.rbs
+homepage: https://github.com/treatwell/ruby-style
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/treatwell/ruby-style
+  source_code_uri: https://github.com/treatwell/ruby-style
+  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.6.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: Shared style guide for Treatwell Ruby projects
+test_files: []