ut-rubocop 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 21dfa4b9cf72296581bd0d64f8d1aa5646e208ebfa901658fa4a80b5a4322289
+  data.tar.gz: 39ccc541935d8a7c173b9dcbdc2cc052272a4ba68a844d7b293bd28bfca0e9ca
+SHA512:
+  metadata.gz: f9569d275b7b5604c171bbc3e807870a0c576953388ba4f9e4bf712e0c60c45fcee665f8e0c3a6f62177a5f2774a2efcbb320a045ea5ce7fbe931aef8f0b834b
+  data.tar.gz: b4d498b1a0ce7fb5cab3adf0b380822450451b766eeeb0732f05db583cce8d907368089a3047b27349f6da05f91ba7ce540eab297f8bf24e6752f7ddfe49d187

data/.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ut/style_ruby/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ut-rubocop"
+  spec.version       = UT::StyleRuby::Version::VERSION
+  spec.authors       = ["Justin Aiken"]
+  spec.email         = ["jaiken@usertesting.com"]
+  spec.description   = %q{UT Rubocop}
+  spec.summary       = %q{UserTesting's rubocop rules}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/).reject { |f| f.match(%r{^(spec|doc)/}) }
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rubocop",             "0.82.0"
+  spec.add_dependency "rubocop-rspec",       "1.33.0"
+  spec.add_dependency "rubocop-performance", "1.5.2"
+end

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: default.yml

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/README.markdown

@@ -0,0 +1,44 @@
+# UT Rubocop
+
+This is a basic extraction of common UserTesting ruby styles.
+For rails focused styles, see [ut_rubocop_rails](https://github.com/usertesting/ut_rubocop_rails)
+
+## Installation
+
+Add the gem to your `Gemfile` in the dev/test group:
+
+You don't need to add `rubocop` itself, this takes care of that.
+
+```ruby
+group :test, :development do
+  ...
+  gem "ut-rubocop", require: false
+```
+
+In your `.rubocop.yml` file, add these lines near the top:
+
+```yaml
+inherit_gem:
+  ut-rubocop:
+    - default.yml
+```
+
+## Usage
+
+`bundle exec rubocop`
+
+## License
+
+[MIT](LICENSE).
+
+Library created by [UserTesting](https://usertesting.com)
+
+![UserTesting](doc/UserTesting.png)
+
+## Contributing
+
+1. Fork it ( https://github.com/usertesting/ut_rubocop/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/default.yml

@@ -0,0 +1,409 @@
+require:
+  - rubocop-rspec
+  - rubocop-performance
+
+AllCops:
+  DisabledByDefault: true
+  DisplayCopNames:   true
+  DisplayStyleGuide: true
+  Exclude:
+    - 'app/assets/**/*'
+    - '**/node_modules/**/*'
+    - 'yarn*'
+    - 'loader*'
+    - 'webpack*'
+    - 'gems/**/*'
+    - 'vendor/**/*'
+
+# ------------------------------------ Bundler -------------------------------------------
+Bundler/DuplicatedGem:
+  Enabled: true
+# ------------------------------------ /Bundler ------------------------------------------
+
+# ------------------------------------ Rspec/FactoryBot ----------------------------------
+FactoryBot/AttributeDefinedStatically:
+  Description: 'Check for deprecated factory attribute assignments.'
+  Enabled: true
+# ------------------------------------ /Rspec/FactoryBot ---------------------------------
+
+# ------------------------------------ Lints ---------------------------------------------
+Layout/BlockAlignment:
+  Enabled: true
+
+Lint/CircularArgumentReference:
+  Enabled: true
+
+Lint/Debugger:
+  Description: 'Check for `debugger` or `binding.pry` statements left in.'
+  Enabled: true
+  Exclude:
+    - bin/scripts/datacheck.rb
+    - spec/support/capybara.rb # Optional debugging tool not hit in regular codepaths
+
+Lint/DeprecatedClassMethods:
+  Description: 'Check for deprecated class method calls.'
+  Enabled: true
+
+Lint/DuplicateHashKey:
+  Description: 'Check for duplicate keys in hash literals.'
+  Enabled: true
+
+Lint/DuplicateMethods:
+  Description: 'Check for duplicate method definitions.'
+  Enabled: true
+
+Lint/EachWithObjectArgument:
+  Description: 'Check for immutable argument given to each_with_object.'
+  Enabled: true
+
+Lint/ElseLayout:
+  Description: 'Check for odd code arrangement in an else block.'
+  Enabled: true
+
+Lint/EmptyEnsure:
+  Description: 'Checks for empty ensure block.'
+  Enabled: true
+
+Lint/EmptyInterpolation:
+  Description: 'Checks for empty string interpolation.'
+  Enabled: true
+
+Style/EndBlock:
+  Description: 'END blocks should not be placed inside method definitions.'
+  Enabled: true
+
+Lint/EnsureReturn:
+  Description: 'Do not use return in an ensure block.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-return-ensure'
+  Enabled: true
+
+Lint/FlipFlop:
+  Enabled: true
+
+Lint/FloatOutOfRange:
+  Description: >-
+                 Catches floating-point literals too large or small for Ruby to
+                 represent.
+  Enabled: true
+
+Lint/FormatParameterMismatch:
+  Description: 'The number of parameters to format/sprint must match the fields.'
+  Enabled: true
+
+Lint/ImplicitStringConcatenation:
+  Description: Checks for adjacent string literals on the same line, which could better be represented as a single string literal.
+  Enabled: true
+
+Lint/InheritException:
+  Description: 'Avoid inheriting from the `Exception` class.'
+  Enabled: true
+
+Lint/LiteralInInterpolation:
+  Description: 'Checks for literals used in interpolation.'
+  Enabled: true
+
+Lint/Loop:
+  Enabled: true
+
+Lint/NestedMethodDefinition:
+  Description: 'Do not use nested method definitions.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-nested-methods'
+  Enabled: true
+
+Lint/NextWithoutAccumulator:
+  Description: Do not omit the accumulator when calling `next` in a `reduce`/`inject` block.
+  Enabled: true
+
+Lint/PercentStringArray:
+  Description: "Checks for unwanted commas and quotes in %w/%W literals."
+  Enabled: true
+
+Lint/PercentSymbolArray:
+  Description: "Checks for unwanted commas and colons in %i/%I literals."
+  Enabled: true
+
+Lint/RandOne:
+  Description: Checks for `rand(1)` calls. Such calls always return `0` and most likely a mistake.
+  Enabled: true
+
+Lint/RescueException:
+  Description: 'Avoid rescuing the Exception class.'
+  StyleGuide: 'https://github.com/github/rubocop-github/blob/master/STYLEGUIDE.md#exceptions'
+  Enabled: true
+
+Lint/ShadowedException:
+  Description:  Avoid rescuing a higher level exception before a lower level exception.
+  Enabled: true
+
+Lint/RedundantStringCoercion:
+  Enabled: true
+
+Lint/UnderscorePrefixedVariableName:
+  Enabled: true
+
+Lint/RedundantSplatExpansion:
+  Enabled: true
+
+Layout/IndentationConsistency:
+  Description: Checks for inconsistent indentation.
+  Enabled: true
+  StyleGuide: 'https://rubystyle.guide#spaces-indentation'
+  EnforcedStyle: indented_internal_methods
+
+Lint/UnreachableCode:
+  Description: 'Unreachable code.'
+  Enabled: true
+  Exclude:
+    - spec/lib/ut/cache_backed_mutex_spec.rb # Not truly unreachable
+
+Lint/UnusedMethodArgument:
+  Description: 'Checks for unused method arguments.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#underscore-unused-vars'
+  Enabled: true
+  Exclude:
+    - app/smart/**/*.rb      # Smart does this by design w/ example resources
+    - app/decorators/**/*.rb # to_json(*args) shouldn't trigger this
+
+Lint/UselessComparison:
+  Description: 'Checks for comparison of something with itself.'
+  Enabled: true
+
+Lint/UselessElseWithoutRescue:
+  Description: 'Checks for useless `else` in `begin..end` without `rescue`.'
+  Enabled: true
+
+Lint/UselessSetterCall:
+  Description: 'Checks for useless setter call to a local variable.'
+  Enabled: true
+
+Lint/Void:
+  Enabled: true
+
+# ------------------------------------ /Lints -------------------------------------------
+
+# ------------------------------------ Rails --------------------------------------------
+Rails/Exit:
+  Description: >-
+                  Favor `fail`, `break`, `return`, etc. over `exit` in
+                  application or library code outside of Rake files to avoid
+                  exits during unit testing or running in production.
+  Enabled: true
+
+Rails/Output:
+  Description: 'Checks for calls to puts, print, etc.'
+  Enabled: true
+  Exclude:
+    - db/migrate/*.rb
+    - lib/perform_deployment.rb
+    - lib/asset_manifest.rb
+    - lib/chores/log.rb
+    - lib/generators/chore/chore_generator.rb
+
+Rails/PluralizationGrammar:
+  Description: 'Checks for incorrect grammar when using methods like `3.day.ago`.'
+  Enabled: true
+
+Rails/ScopeArgs:
+  Description: 'Checks the arguments of ActiveRecord scopes.'
+  Enabled: true
+
+Rails/UniqBeforePluck:
+  Description: 'Prefer the use of uniq or distinct before pluck.'
+  Enabled: true
+
+Rails/ActiveRecordAliases:
+  Description: 'Checks that ActiveRecord aliases are not used. The direct method names are more clear and easier to read.'
+  Enabled: true
+
+# ------------------------------------ /Rails --------------------------------------------
+
+
+# ------------------------------------ Style --------------------------------------------
+Style/ArrayJoin:
+  Enabled: true
+
+Naming/AsciiIdentifiers:
+  Enabled: true
+
+Style/BeginBlock:
+  Enabled: true
+
+Style/BlockComments:
+  Enabled: true
+
+Layout/BlockEndNewline:
+  Enabled: true
+
+Style/CaseEquality:
+  Enabled: true
+
+Style/CharacterLiteral:
+  Enabled: true
+
+Naming/ClassAndModuleCamelCase:
+  Enabled: true
+
+Style/ClassMethods:
+  Enabled: true
+
+Style/DefWithParentheses:
+  Enabled: true
+
+Layout/EndOfLine:
+  Enabled: true
+
+Naming/FileName:
+  Enabled: true
+  ExpectMatchingDefinition: false
+  IgnoreExecutableScripts: true
+
+Style/For:
+  Enabled: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  AutoCorrect: false
+
+Layout/InitialIndentation:
+  Enabled: true
+
+Style/LambdaCall:
+  Enabled: true
+
+Style/MethodCallWithoutArgsParentheses:
+  Enabled: true
+
+Style/MethodDefParentheses:
+  Enabled: true
+
+Naming/MethodName:
+  Enabled: true
+  EnforcedStyle: snake_case
+  Exclude:
+    - spec/support/fresh_eyes_shared_code.rb #TesterA/TesterB makes sense
+
+Style/MultilineIfThen:
+  Enabled: true
+
+Style/NilComparison:
+  Enabled: true
+
+Style/Not:
+  Enabled: true
+
+Style/OneLineConditional:
+  Enabled: true
+
+Style/RedundantSortBy:
+  Enabled: true
+
+Style/Sample:
+  Enabled: true
+
+Layout/SpaceAfterColon:
+  Enabled: true
+
+Layout/SpaceAfterComma:
+  Enabled: true
+
+Layout/SpaceAfterMethodName:
+  Enabled: true
+
+Layout/SpaceAfterNot:
+  Enabled: true
+
+Layout/SpaceAfterSemicolon:
+  Enabled: true
+
+Layout/SpaceAroundBlockParameters:
+  Enabled: true
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  Enabled: true
+
+Layout/SpaceInsideArrayPercentLiteral:
+  Enabled: true
+
+Layout/SpaceInsideArrayLiteralBrackets:
+  Enabled: true
+
+Layout/SpaceInsideReferenceBrackets:
+  Enabled: true
+
+Layout/SpaceInsideParens:
+  Enabled: true
+
+Layout/SpaceInsideRangeLiteral:
+  Enabled: true
+
+Style/StabbyLambdaParentheses:
+  Enabled: true
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/Strip:
+  Enabled: true
+
+Style/StructInheritance:
+  Description: 'Checks for inheritance from Struct.new.'
+  StyleGuide: '#no-extend-struct-new'
+  Enabled: true
+
+Layout/IndentationStyle:
+  Enabled: true
+
+Layout/TrailingEmptyLines:
+  Enabled: true
+  EnforcedStyle: final_newline
+
+Layout/TrailingWhitespace:
+  Enabled: true
+
+Layout/ConditionPosition:
+  Description: Checks for condition placed in a confusing position relative to the keyword.
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#same-line-condition'
+  Enabled: true
+
+Layout/DefEndAlignment:
+  Description: "Makes sure def/ends line up"
+  Enabled: true
+
+
+# ------------------------------------ /Style --------------------------------------------
+
+# ------------------------------------ Performance -----------------------------------------
+Performance/Count:
+  Enabled: true
+
+Performance/Detect:
+  Enabled: true
+
+Performance/DoubleStartEndWith:
+  Enabled: true
+
+Performance/EndWith:
+  Enabled: true
+
+Performance/FlatMap:
+  Enabled: true
+
+Performance/RedundantMerge:
+  Enabled: true
+  MaxKeyValuePairs: 1
+
+Performance/ReverseEach:
+  Enabled: true
+
+Performance/Size:
+  Enabled: true
+
+Performance/StartWith:
+  Enabled: true
+# ------------------------------------ /Performance -----------------------------------------
+
+# ------------------------------------ Security ---------------------------------------------
+Security/Eval:
+  Enabled: true
+# ------------------------------------ /Security --------------------------------------------

data/lib/ut/style_ruby.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "ut/style_ruby/version"
+
+module UT
+  module StyleRuby
+  end
+end

data/lib/ut/style_ruby/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module UT
+  module StyleRuby
+    module Version
+      VERSION = "0.0.1"
+    end
+  end
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: ut-rubocop
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Justin Aiken
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.82.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.82.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.33.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.33.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+description: UT Rubocop
+email:
+- jaiken@usertesting.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gemspec"
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- README.markdown
+- default.yml
+- lib/ut/style_ruby.rb
+- lib/ut/style_ruby/version.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key:
+specification_version: 4
+summary: UserTesting's rubocop rules
+test_files: []