datarockets-style 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ef40260e95ced035f4c8f86b18c807997a4e79228c72e75a880477fecb8030e
-  data.tar.gz: b35d77e092533855df4092585e8af229653859c6cce685bed399f50880d5bc49
+  metadata.gz: 16590c13f8a15d26842216bb4c0b411c9431a177b7d81b32b9e7a074257b4cf5
+  data.tar.gz: 440e87351bf3e6900d114650fede11f1ab68b2ba5f1d72fe6e599758fec6f346
 SHA512:
-  metadata.gz: a8b0a2bcb81d48837a708f337e3f37baba4e26d86f1be42fa02c12f441e18286b1164996a0a0026f870886a887c7664300683de2b80dee0e7fc6c4721934fce2
-  data.tar.gz: 0dd7f1c7bd2a72a7cbebe4fb5eaf4b399f53d014b0ecfe701be979917e09e7bc7467367d0dced76d25f9a76ad369b88da746285774e092b0078eea180209c913
+  metadata.gz: be32cf2f4da3c94b9e532bfd0e0a2f0d416200ebc5d2992fdb3ff223b9b9603dd4f78ff198640c4500964cda5f82b93b5484694c909371d53bea2cd185356c0a
+  data.tar.gz: b0120bd764544c9fe6458b981f3b5174d96eaed7980ea29b8ca4b73065b8794225ab832478ee0c7666a1b4ae13908e17d403f30351c80fdd9ec17a4ef6247d49

data/.gitignore

@@ -7,3 +7,4 @@
 
 .byebug_history
 .idea
+Gemfile.lock

data/CHANGELOG.md

@@ -4,19 +4,36 @@ The format is described in [Contributing notes](CONTRIBUTING.md#changelog-entry-
 
 ## master
 
+## 1.2.0
+
+### Added
+
+* [#219](https://github.com/datarockets/datarockets-style/issues/219) Add `RSpec/PreferBeforeOverSetup` cop. ([@paydaylight][])
+
+### Changed
+
+* [#233](https://github.com/datarockets/datarockets-style/issues/233) Setup `EnforcedStyleForMultiline` for `Style/TrailingCommaInArguments` and `Style/TrailingCommaInArrayLiteral` rules. ([@paydaylight][])
+* [#124](https://github.com/datarockets/datarockets-style/issues/124) Move gem dependencies to `./datarockets-style.gemspec` and drop `Gemfile.lock` tracking. ([@paydaylight][])
+* [#253](https://github.com/datarockets/datarockets-style/issues/253) Update rubocop to `1.10`. ([@paydaylight][])
+* [#124](https://github.com/datarockets/datarockets-style/issues/124) Update rubocop-rails to `2.9`. ([@paydaylight][])
+
+### Fixed
+
+* [#251](https://github.com/datarockets/datarockets-style/issues/251) Update documentation to match `1.1.0` release changes. ([@paydaylight][])
+
 ## 1.1.0 (2021-02-09)
 
 ### Changed
 
 * Setup `EnforcedStyleForMultiline` for `Style/TrailingCommaInHashLiteral` rule. ([@r.dubrovsky][])
-* Update rubocop to ```1.9.1```.([@paydaylight][])
-* Update rubocop-rails requirement to ```>= 2.8.0, < 2.10.0```. ([@paydaylight][])
+* Update rubocop to `1.9.1`. ([@paydaylight][])
+* Update rubocop-rails requirement to `>= 2.8.0, < 2.10.0`. ([@paydaylight][])
 * Update rubocop-rspec to `2.2.0`. ([@paydaylight][])
-* Change ```Datarockets::Style``` module to ```DatarocketsStyle```. ([@paydaylight][])
+* Change `Datarockets::Style` module to `DatarocketsStyle`. ([@paydaylight][])
 
 ### Fixed
 
-* [#177](https://github.com/datarockets/datarockets-style/issues/177) set ```Layout/MultilineOperationIndentation``` to indented ([@paydaylight][])
+* [#177](https://github.com/datarockets/datarockets-style/issues/177) set `Layout/MultilineOperationIndentation` to indented ([@paydaylight][])
 
 ## 1.0.0 (2020-11-10)
 

data/Gemfile

@@ -3,7 +3,3 @@ source "https://rubygems.org"
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 gemspec
-
-gem "pry-byebug"
-gem "rake", "~> 13.0"
-gem "rspec", "~> 3.10"

data/README.md

@@ -10,14 +10,14 @@ Add this line to your application's Gemfile:
 
 ```ruby
 group :test, :development do
-  gem 'datarockets-style', '~> 1.0.0'
+  gem 'datarockets-style', '~> 1.1.0'
 end
 ```
 
 Or, for a Ruby library, add this to your gemspec:
 
 ```ruby
-spec.add_development_dependency 'datarockets-style', '~> 1.0.0'
+spec.add_development_dependency 'datarockets-style', '~> 1.1.0'
 ```
 
 And then execute:
@@ -108,28 +108,28 @@ Result of the formatter is compatible with rubocop config or rubocop todo file.
 For running that cop, just print in your command like
 
 ```bash
-$ bundle exec rubocop -f TodoListFormatter -r datarockets/style
+$ bundle exec rubocop -f TodoListFormatter -r datarockets_style
 Inspecting 10 files
 ...CC.CC..
 10 files inspected, 7 offenses detected
 
 Layout/IndentationConsistency:
   Exclude:
-    - 'spec/datarockets/style/formatter/todo_list_formatter_spec.rb' # 1
+    - 'spec/datarockets_style/formatter/todo_list_formatter_spec.rb' # 1
 
 Naming/MemoizedInstanceVariableName:
   Exclude:
-    - 'lib/datarockets/style/formatter/todo_list_formatter/report_summary.rb' # 1
+    - 'lib/datarockets_style/formatter/todo_list_formatter/report_summary.rb' # 1
 
 RSpec/ExampleLength:
   Exclude:
-    - 'spec/datarockets/style/formatter/todo_list_formatter/report_summary_spec.rb' # 1
-    - 'spec/datarockets/style/formatter/todo_list_formatter_spec.rb' # 2
+    - 'spec/datarockets_style/formatter/todo_list_formatter/report_summary_spec.rb' # 1
+    - 'spec/datarockets_style/formatter/todo_list_formatter_spec.rb' # 2
 
 Style/Documentation:
   Exclude:
-    - 'lib/datarockets/style/formatter/todo_list_formatter/report_summary.rb' # 1
-    - 'lib/datarockets/style/formatter/todo_list_formatter.rb' # 1
+    - 'lib/datarockets_style/formatter/todo_list_formatter/report_summary.rb' # 1
+    - 'lib/datarockets_style/formatter/todo_list_formatter.rb' # 1
 ```
 
 #### Autocorrection
@@ -137,24 +137,24 @@ Style/Documentation:
 If you run the formatter with autocorrection options, the formatter skip corrected cop and does not include it to the result.
 
 ```bash
-$ bundle exec rubocop -f TodoListFormatter -r datarockets/style -a
+$ bundle exec rubocop -f TodoListFormatter -r datarockets_style -a
 Inspecting 10 files
 ...CC.CC..
 10 files inspected, 7 offenses detected, 1 offenses corrected
 
 Naming/MemoizedInstanceVariableName:
   Exclude:
-    - 'lib/datarockets/style/formatter/todo_list_formatter/report_summary.rb' # 1
+    - 'lib/datarockets_style/formatter/todo_list_formatter/report_summary.rb' # 1
 
 RSpec/ExampleLength:
   Exclude:
-    - 'spec/datarockets/style/formatter/todo_list_formatter/report_summary_spec.rb' # 1
-    - 'spec/datarockets/style/formatter/todo_list_formatter_spec.rb' # 2
+    - 'spec/datarockets_style/formatter/todo_list_formatter/report_summary_spec.rb' # 1
+    - 'spec/datarockets_style/formatter/todo_list_formatter_spec.rb' # 2
 
 Style/Documentation:
   Exclude:
-    - 'lib/datarockets/style/formatter/todo_list_formatter/report_summary.rb' # 1
-    - 'lib/datarockets/style/formatter/todo_list_formatter.rb' # 1
+    - 'lib/datarockets_style/formatter/todo_list_formatter/report_summary.rb' # 1
+    - 'lib/datarockets_style/formatter/todo_list_formatter.rb' # 1
 ```
 
 ## Non-goals of RuboCop
@@ -178,4 +178,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Datarockets::Style project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).
+Everyone interacting in the DatarocketsStyle project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).

data/config/base.yml

@@ -190,5 +190,11 @@ Style/StringConcatenation:
 Style/StringLiterals:
   EnforcedStyle: double_quotes
 
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
 Style/TrailingCommaInHashLiteral:
   EnforcedStyleForMultiline: comma

data/config/rspec.yml

@@ -36,3 +36,6 @@ RSpec/MultipleMemoizedHelpers:
 
 RSpec/NestedGroups:
   Enabled: false
+
+RSpec/PreferBeforeOverSetup:
+  Enabled: true

data/datarockets-style.gemspec

@@ -30,7 +30,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "rubocop", ">= 1.2  ", "< 2.0"
-  spec.add_dependency "rubocop-rails", ">= 2.8.0", "< 2.10.0"
+  spec.add_dependency "rubocop", "~> 1.10"
+  spec.add_dependency "rubocop-rails", "~> 2.9"
   spec.add_dependency "rubocop-rspec", "~> 2.0"
+
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.10"
 end

data/doc/STYLE_GUIDE.md

@@ -392,6 +392,86 @@ def foo
 end
 ```
 
+* <a name="style-trailing-comma-in-arguments"></a>
+  Requires a comma after the last argument, but only for parenthesized method calls where each argument is on its own line.
+  <sup>[[link](#style-trailing-comma-in-arguments)]</sup>
+
+```ruby
+# bad
+method(1, 2,)
+
+# good
+method(1, 2)
+
+# bad
+method(
+  1, 2,
+  3,
+)
+
+# good
+method(
+  1, 2,
+  3
+)
+
+# bad
+method(
+  1, 2, 3,
+)
+
+# good
+method(
+  1, 2, 3
+)
+
+# good
+method(
+  1,
+  2,
+)
+```
+
+* <a name="style-trailing-comma-in-array-literals"></a>
+  Requires a comma after last item in an array, but only when each item is on its own line.
+  <sup>[[link](#style-trailing-comma-in-array-literals)]</sup>
+
+```ruby
+# bad
+a = [1, 2,]
+
+# good
+a = [1, 2]
+
+# bad
+a = [
+  1, 2,
+  3,
+]
+
+# good
+a = [
+  1, 2,
+  3
+]
+
+# bad
+a = [
+  1, 2, 3,
+]
+
+# good
+a = [
+  1, 2, 3
+]
+
+# good
+a = [
+  1,
+  2,
+]
+```
+
 * <a name="style-trailing-comma-in-hash-literal"></a>
   Requires a comma after the last item in a hash.
   <sup>[[link](#style-trailing-comma-in-hash-literal)]</sup>

data/doc/STYLE_GUIDE_RSPEC.md

@@ -186,3 +186,19 @@ it "returns the last widget" do
   expect(Widget.last).to eq my_widget
 end
 ```
+
+* <a name="rspec-prefer-before"></a>
+  Prefer using `before` instead of `setup`.
+  <sup>[[link](#rspec-prefer-before)]</sup>
+
+```ruby
+# bad
+setup do
+  allow(post).to receive(:publish!)
+end
+
+# good
+before do
+  allow(post).to receive(:publish!)
+end
+```

data/lib/datarockets_style.rb

@@ -5,6 +5,7 @@ require "datarockets_style/version"
 
 require "datarockets_style/cop/layout/array_alignment_extended"
 require "datarockets_style/cop/style/nested_interpolation"
+require "datarockets_style/cop/rspec/prefer_before_over_setup"
 
 # Top level module for datarockets-style
 module DatarocketsStyle

data/lib/datarockets_style/cop/rspec/prefer_before_over_setup.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module DatarocketsStyle
+  module Cop
+    module RSpec
+      # Checks that tests use `before` instead of RoR unit-test `setup` method (part of `rspec-rails` gem)
+      #
+      # bad
+      #
+      # setup do
+      #   allow(post).to receive(:publish!)
+      # end
+      #
+      # good
+      #
+      # before do
+      #   allow(post).to receive(:publish!)
+      # end
+      class PreferBeforeOverSetup < RuboCop::Cop::Cop
+        MSG = "Use `before` instead of `setup`."
+
+        def_node_matcher :setup_call?, <<-PATTERN
+          (block
+            (send _ :setup)
+            (args) _)
+        PATTERN
+
+        def on_block(node)
+          return unless setup_call?(node)
+
+          add_offense(node)
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            block_internals = node.source.split(/ /)
+            corrector.replace node.loc.expression, ["before", *block_internals[1..-1]].join(" ")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datarockets_style/version.rb

@@ -1,3 +1,3 @@
 module DatarocketsStyle
-  VERSION = "1.1.0".freeze
+  VERSION = "1.2.0".freeze
 end

data/manual/cops_layout.md

@@ -52,6 +52,30 @@ Name | Default value | Configurable values
 EnforcedStyle | `with_first_parameter` | `with_first_parameter`, `with_fixed_indentation`
 IndentationWidth | `<none>` | Integer
 
+# RSpec
+
+## RSpec/PreferBeforeOverSetup
+
+Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+--- | --- | --- | --- | ---
+Enabled | Yes | Yes | 1.2.0 | -
+
+Checks that tests use `before` instead of RoR unit-test `setup` method (part of `rspec-rails` gem)
+
+### Example
+
+```ruby
+# bad
+setup do
+  allow(post).to receive(:publish!)
+end
+
+# good
+before do
+  allow(post).to receive(:publish!)
+end
+```
+
 # Style
 
 ## Style/NestedInterpolation

metadata

@@ -1,55 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: datarockets-style
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Roman Dubrovsky
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-09 00:00:00.000000000 Z
+date: 2021-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.2'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '1.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.2'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '1.10'
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.8.0
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.10.0
+        version: '2.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.8.0
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.10.0
+        version: '2.9'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -64,7 +52,49 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-description: 
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+description:
 email:
 - r.dubrovsky@datarockets.com
 executables: []
@@ -82,7 +112,6 @@ files:
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - Makefile
 - README.md
@@ -100,6 +129,7 @@ files:
 - doc/STYLE_GUIDE_RSPEC.md
 - lib/datarockets_style.rb
 - lib/datarockets_style/cop/layout/array_alignment_extended.rb
+- lib/datarockets_style/cop/rspec/prefer_before_over_setup.rb
 - lib/datarockets_style/cop/style/nested_interpolation.rb
 - lib/datarockets_style/formatter/todo_list_formatter.rb
 - lib/datarockets_style/formatter/todo_list_formatter/report_summary.rb
@@ -110,7 +140,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -125,8 +155,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.5
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Datarockets style guides and shared style configs
 test_files: []

data/Gemfile.lock

@@ -1,88 +0,0 @@
-PATH
-  remote: .
-  specs:
-    datarockets-style (1.1.0)
-      rubocop (>= 1.2, < 2.0)
-      rubocop-rails (>= 2.8.0, < 2.10.0)
-      rubocop-rspec (~> 2.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (6.1.1)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
-    ast (2.4.2)
-    byebug (11.1.3)
-    coderay (1.1.2)
-    concurrent-ruby (1.1.7)
-    diff-lcs (1.4.4)
-    i18n (1.8.7)
-      concurrent-ruby (~> 1.0)
-    method_source (1.0.0)
-    minitest (5.14.3)
-    parallel (1.20.1)
-    parser (3.0.0.0)
-      ast (~> 2.4.1)
-    pry (0.13.1)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    pry-byebug (3.9.0)
-      byebug (~> 11.0)
-      pry (~> 0.13.0)
-    rack (2.2.3)
-    rainbow (3.0.0)
-    rake (13.0.3)
-    regexp_parser (2.0.3)
-    rexml (3.2.4)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.0)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.0)
-    rubocop (1.9.1)
-      parallel (~> 1.10)
-      parser (>= 3.0.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.4.1)
-      parser (>= 2.7.1.5)
-    rubocop-rails (2.9.1)
-      activesupport (>= 4.2.0)
-      rack (>= 1.1)
-      rubocop (>= 0.90.0, < 2.0)
-    rubocop-rspec (2.1.0)
-      rubocop (~> 1.0)
-      rubocop-ast (>= 1.1.0)
-    ruby-progressbar (1.11.0)
-    tzinfo (2.0.4)
-      concurrent-ruby (~> 1.0)
-    unicode-display_width (2.0.0)
-    zeitwerk (2.4.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  datarockets-style!
-  pry-byebug
-  rake (~> 13.0)
-  rspec (~> 3.10)
-
-BUNDLED WITH
-   2.1.4