datarockets-style 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: cf58c59e6d4a4035c60796ef26a8c999cd2003ea58f0b4c3f018a49fd3d5a9c0
-  data.tar.gz: 993b7f3c7e99e6a959c328c9f76630eea7227be1fd53038295c1c2d30a0f1507
+SHA1:
+  metadata.gz: 4344b6ab0459c0d422d77d2138d4fdd459ec65e4
+  data.tar.gz: 74cde7a5b535323c47c0ac6670fe79b3a803a27b
 SHA512:
-  metadata.gz: a8ab4c6b3988709ca2d096defb42478ba657f03603dcd0ca63800769f3106478d228c7e41a208771ffae7a34d53386c5052bc7f0e9dde7c60676be6e7ad48223
-  data.tar.gz: 7b42a8646ba555a70aa9e77b99b729e6fb9f9f8abde73199a219672d5afcbedd02c608461f99a9d7d58a077b6df94188b2b82dace0e517f0613fc32f52b13181
+  metadata.gz: 89939e5bf7174b4be6c2cee93d9d19d26232cb034b19818a6bf2ac87cf557f39cf72834c67a812edd92845cf757e97eb51faf9f668484a0d3a38baa72757432a
+  data.tar.gz: da83a217a19f55e2721f496cc1de35d752cc1699e52f9b5a7557986d67b5e43eadd0ecb6e4c300795f6c67f35d2aff4cca8bab7417b65b0feaa8538a8385959b

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,6 +1,6 @@
 Before you submit a pull request, please make sure you have to follow:
 
-- [ ] read and know items from the [Contributing Guide](CONTRIBUTING.md#pull-requests)
+- [ ] read and know items from the [Contributing Guide](https://github.com/datarockets/datarockets-style/blob/master/CONTRIBUTING.md#pull-requests)
 - [ ] add a description of the problem you're trying to solve (short summary from related issue)
 - [ ] verified that cops are ordered by alphabet
 - [ ] add a note to the style guide docs (if it needs)

data/.github/workflows/main.yml

@@ -0,0 +1,41 @@
+name: Run tests
+
+on:
+  pull_request:
+    branches:
+      - 'master'
+  push:
+    branches:
+      - 'master'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v1
+
+    - uses: actions/cache@v1
+      with:
+        path: vendor/bundle
+        key: ${{ runner.os }}-gem-${{ hashFiles('**/Gemfile.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-gem-
+
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+
+    - name: Install and run bundler
+      run: |
+        gem install bundler
+        bundle config path vendor/bundle
+        bundle install --jobs 4 --retry 3
+
+    - name: Run linter
+      run: make lint
+
+    - name: Run tests
+      run: make test
+

data/.rubocop.yml

@@ -2,5 +2,9 @@ inherit_from:
   - config/ruby.yml
   - config/rspec.yml
 
+inherit_mode:
+  merge:
+    - Exclude
+
 AllCops:
   TargetRubyVersion: 2.3

data/CHANGELOG.md

@@ -4,8 +4,26 @@ The format is described in [Contributing notes](CONTRIBUTING.md#changelog-entry-
 
 ## master (unreleased)
 
+## 0.7.0 (2020-01-27)
 
-## 0.6.2(2019-12-05)
+### Added
+
+* [#130](https://github.com/datarockets/datarockets-style/issues/130): Add Layout/ArrayAlignmentExtended cop ([@nikitasakov][])
+
+### Changed
+
+* Update rubocop to `0.79.0`.
+* Update rubocop-rspec to `1.37.1`.
+* Add notes for setting up Rspec configuration for fixing Rspec internal style issues. ([@r.dubrovsky][])
+* [#58](https://github.com/datarockets/datarockets-style/issues/58): Disable `RSpec/LetSetup` cop by default. ([@ula][])
+
+### Fixed
+
+* [#80](https://github.com/datarockets/datarockets-style/issues/80): Allows adding additional files and directories to excluding block for rubocop. ([@nikitasakov][])
+* Fix documentation issues. ([@ula][])
+
+
+## 0.6.2 (2019-12-05)
 
 ### Changed
 
@@ -52,11 +70,11 @@ The format is described in [Contributing notes](CONTRIBUTING.md#changelog-entry-
 ### Changed
 
 * Update rubocop-rspec to `1.35.0`. ([@r.dubrovsky][])
-* Use contenxt-dependent style for curly braces around hash params. ([@v.kuzmik][])
+* Use context-dependent style for curly braces around hash params. ([@v.kuzmik][])
 * Use leading underscores in cached instance variable name (cop: `Naming/MemoizedInstanceVariableName`). ([@ula][])
-* Allow use `for` wiht `RSpec/ContextWording` cop. ([@r.dubrovsky][])
-* Change `Layout/AlignArguments` and `Layout/IndentFirstHashElement` cops for aliging arguments with fixed indentation. ([@r.dubrovsky][])
-* Enable `Layout/MultilineMethodCallIndentation` cop for aliging arguments with fixed indentation. ([@r.dubrovsky][], [@ula][])
+* Allow use `for` with `RSpec/ContextWording` cop. ([@r.dubrovsky][])
+* Change `Layout/AlignArguments` and `Layout/IndentFirstHashElement` cops for aligning arguments with fixed indentation. ([@r.dubrovsky][])
+* Enable `Layout/MultilineMethodCallIndentation` cop for aligning arguments with fixed indentation. ([@r.dubrovsky][], [@ula][])
 
 ## 0.3.0 (2019-08-02)
 
@@ -78,7 +96,7 @@ The format is described in [Contributing notes](CONTRIBUTING.md#changelog-entry-
 ### Changed
 
 * Update rubocop to `0.73.0`. ([@r.dubrovsky][])
-* Use prefered variable name in rescued exceptions (cop: `Naming/RescuedExceptionsVariableName`). ([@ula][])
+* Use preferred variable name in rescued exceptions (cop: `Naming/RescuedExceptionsVariableName`). ([@ula][])
 * Disable `RSpec/ImplicitSubject` cop for rspec files. ([@r.dubrovsky][])
 
 ## 0.1.0 (2019-06-27)
@@ -97,16 +115,17 @@ The format is described in [Contributing notes](CONTRIBUTING.md#changelog-entry-
 * Change the limit for size of line to 120 symbols. ([@r.dubrovsky][])
 * Disable `Metrics/BlockLength` cop for rspec files. ([@r.dubrovsky][])
 * Exclude rubocop checking for some config directories. ([@r.dubrovsky][])
-* Enable prafering double quotes for string literals. ([@r.dubrovsky][])
-* Do not add spaces beetwen hash literal braces (cop `Layout/SpaceInsideHashLiteralBraces`). ([@r.dubrovsky][])
+* Enable preferring double quotes for string literals. ([@r.dubrovsky][])
+* Do not add spaces between hash literal braces (cop `Layout/SpaceInsideHashLiteralBraces`). ([@r.dubrovsky][])
 * Prefer normal style for `Layout/IndentationConsistency` cop for Rails apps too. ([@r.dubrovsky][])
 * Change style to `variable` for `Layout/EndAlignment` cop. ([@r.dubrovsky][])
 * Change style to `with_fixed_indentation` with indentation width 2 for `Layout/AlignParameter` cop. ([@r.dubrovsky][])
-* Always ingone hash aligning for key word arguments. (cop: `Layout/AlignHash`) ([@r.dubrovsky][])
+* Always ignore hash aligning for key word arguments. (cop: `Layout/AlignHash`) ([@r.dubrovsky][])
 
 [@r.dubrovsky]: https://github.com/roman-dubrovsky
 [@aleks]: https://github.com/AleksSenkou
 [@ula]: https://github.com/lazycoder9
 [@v.kuzmik]: https://github.com/TheBlackArroVV/
 [@a.branzeanu]: https://github.com/texpert
+[@nikitasakov]: https://github.com/nikitasakov
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    datarockets-style (0.6.2)
+    datarockets-style (0.7.0)
       rubocop (~> 0.76)
       rubocop-rspec (~> 1.36)
 
@@ -15,7 +15,7 @@ GEM
     jaro_winkler (1.5.4)
     method_source (0.9.2)
     parallel (1.19.1)
-    parser (2.6.5.0)
+    parser (2.7.0.2)
       ast (~> 2.4.0)
     pry (0.12.2)
       coderay (~> 1.1.0)
@@ -38,17 +38,17 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.0)
-    rubocop (0.77.0)
+    rubocop (0.79.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 2.7.0.1)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.7)
-    rubocop-rspec (1.37.0)
+    rubocop-rspec (1.37.1)
       rubocop (>= 0.68.1)
     ruby-progressbar (1.10.1)
-    unicode-display_width (1.6.0)
+    unicode-display_width (1.6.1)
 
 PLATFORMS
   ruby

data/Makefile

@@ -0,0 +1,10 @@
+install:
+	bundle install
+
+test:
+	bundle exec rspec spec
+
+lint:
+	bundle exec rubocop
+
+.PHONY: test

data/README.md

@@ -1,6 +1,6 @@
 # Datarockets::Style [![Gem Version](https://badge.fury.io/rb/datarockets-style.svg)](https://badge.fury.io/rb/datarockets-style)
 
-Datarockets shared style configs and notes of code-style convensions. Based on the [Rubocop](https://github.com/rubocop-hq/rubocop) util.
+Datarockets shared style configs and notes of code-style conventions. Based on the [Rubocop](https://github.com/rubocop-hq/rubocop) util.
 
 This config enforces many of the guidelines outlined in the datarockets [Ruby Style Guide](doc/STYLE_GUIDE.md).
 
@@ -86,13 +86,13 @@ P.S. The string literals in this gem are using double quotes by default.
 
 ##### Tips
 
-For an existing project, we suggest to run rubocop with both styles and choose which has fewer offenses (which is more popular in the current project).
+For an existing project, we suggest running rubocop with both styles and choose which has fewer offenses (which is more popular in the current project).
 
 ## Formatters
 
 ### ToDo list formatter
 
-This formatter allows us to get list of files for some offense and with number of offenses in each file. This file can be useful if you need to fix a large some cop cop step by step.
+This formatter allows us to get list of files for some offense and with number of offenses in each file. This file can be useful if you need to fix a large some cop step by step.
 
 Result of the formatter is compatible with rubocop config or rubocop todo file.
 

data/config/base.yml

@@ -1,3 +1,5 @@
+require: datarockets/style
+
 Bundler/DuplicatedGem:
   Enabled: true
 
@@ -7,6 +9,35 @@ Bundler/OrderedGems:
 Layout/ArgumentAlignment:
   EnforcedStyle: with_fixed_indentation
 
+Layout/ArrayAlignment:
+  Enabled: false
+
+Layout/ArrayAlignmentExtended:
+  Description: >-
+                 Align the elements of an array literal if they span more than
+                 one line.
+  # Alignment of elements of a multi-line array.
+  #
+  # The `with_first_parameter` style aligns the following lines along the same
+  # column as the first element.
+  #
+  #     array = [1, 2, 3,
+  #              4, 5, 6]
+  #
+  # The `with_fixed_indentation` style aligns the following lines with one
+  # level of indentation relative to the start of the line with start of array.
+  #
+  #     array = [1, 2, 3,
+  #       4, 5, 6]
+  EnforcedStyle: with_fixed_indentation
+  SupportedStyles:
+    - with_first_parameter
+    - with_fixed_indentation
+  # By default, the indentation width from Layout/IndentationWidth is used
+  # But it can be overridden by setting this parameter
+  IndentationWidth: ~
+
+
 Layout/HashAlignment:
   EnforcedLastArgumentHashStyle: always_ignore
 
@@ -20,19 +51,19 @@ Layout/EndAlignment:
 Layout/IndentationConsistency:
   EnforcedStyle: normal
 
+Layout/LineLength:
+  Max: 120
+
 Layout/FirstHashElementIndentation:
   EnforcedStyle: consistent
 
 Layout/MultilineMethodCallIndentation:
-    EnforcedStyle: indented
+  EnforcedStyle: indented
 
 Layout/SpaceInsideHashLiteralBraces:
   EnforcedStyle: no_space
   EnforcedStyleForEmptyBraces: no_space
 
-Metrics/LineLength:
-  Max: 120
-
 Naming/MemoizedInstanceVariableName:
   EnforcedStyleForLeadingUnderscores: required
 

data/config/rspec.yml

@@ -25,6 +25,9 @@ RSpec/ExpectChange:
 RSpec/ImplicitSubject:
   Enabled: false
 
+RSpec/LetSetup:
+  Enabled: false
+
 RSpec/MessageSpies:
   EnforcedStyle: have_received
 

data/doc/STYLE_GUIDE.md

@@ -18,11 +18,11 @@ This is a small list of differences which we have when compared with community s
 ## Bundler
 
 * <a name="bundler-add-once"></a>
-  A Gem's requirements should be listed only once in a Gemfile
+  A Gem's requirements should be listed only once in a Gemfile.
   <sup>[[link](#bundler-add-once)]</sup>
 
 * <a name="bundler-ordering"></a>
-  Gems should be alphabetically sorted within groups. Also you can use a line comment as a group separator.
+  Gems should be alphabetically sorted within groups. Also, you can use a line comment as a group separator.
   <sup>[[link](#bundler-ordering)]</sup>
 
 ## Style
@@ -36,7 +36,7 @@ This is a small list of differences which we have when compared with community s
   <sup>[[link](#style-string-quotes)]</sup>
 
 * <a name="style-hash-aligning"></a>
-  If elements of a hash literal span more than one line we're aligning them by keys.
+  If elements of a hash literal span more than one line, we're aligning them by keys.
   Also, the first hash key is aligned by an indentation level.
   <sup>[[link](#style-hash-aligning)]</sup>
 
@@ -89,7 +89,7 @@ method_call({
 
 * <a name="style-arguments-aligning"></a>
   All arguments on a multi-line method definition are aligning by an indentation level.
-  This rule works as for keywork arguments, as for usual arguments.
+  This rule works as for keyword arguments, as for usual arguments.
   <sup>[[link](#style-arguments-aligning)]</sup>
 
 ```ruby
@@ -151,7 +151,28 @@ def foo(
 end
 ```
 
-* <a name="style-multiline-method-call-indentation">
+* <a name="style-array-aligning"></a>
+  The elements of a multi-line array are aligning by an indentation level.
+  <sup>[[link](#style-array-aligning)]</sup>
+
+```ruby
+# bad
+
+array = [1, 2, 3,
+         4, 5, 6]
+
+# bad
+
+array = [1, 2, 3,
+      4, 5, 6]
+
+# good
+
+array = [1, 2, 3,
+  4, 5, 6]
+```
+
+* <a name="style-multiline-method-call-indentation"></a>
   The indentation of the method name part in method calls that span more than one line are aligning by an indentation level.
   <sup>[[link](#style-multiline-method-call-indentation)]</sup>
 
@@ -227,7 +248,7 @@ end
 ```
 
 * <a name="style-method-indentations"></a>
-  We're prefering a ruby style for methods indentations, not rails. You can check it [here](https://github.com/rubocop-hq/ruby-style-guide#indent-public-private-protected).
+  We're preferring a ruby style for methods indentations, not rails. You can check it [here](https://github.com/rubocop-hq/ruby-style-guide#indent-public-private-protected).
   <sup>[[link](#style-method-indentations)]</sup>
 
 ```ruby
@@ -285,7 +306,7 @@ end
 ```
 
 * <a name="style-hash-spaces"></a>
-  For hash literals not to add scapes after `{` or before `}`. We want to have the advantage of adding visual difference between block and hash literals.
+  For hash literals not to add spaces after `{` or before `}`. We want to have the advantage of adding visual difference between block and hash literals.
   <sup>[[link](#style-hash-spaces)]</sup>
 
 ```ruby
@@ -338,7 +359,7 @@ end
 ```
 
 * <a name="style-cached-instance-variable-name"></a>
-  Use leading underscores in cached instance variable name
+  Use leading underscores in cached instance variable name.
   <sup>[[link](#style-cached-instance-variable-name)]</sup>
 
 ```ruby
@@ -359,8 +380,8 @@ end
 ```
 
 * <a name="style-magic-link"></a>
-  There are not any requried rules for `frozen_string_literal` magic url.
-  Set up [this cop](https://rubocop.readthedocs.io/en/latest/cops_style/#stylefrozenstringliteralcomment) depends  on the project.
+  There are not any required rules for `frozen_string_literal` magic url.
+  Set up [this cop](https://rubocop.readthedocs.io/en/latest/cops_style/#stylefrozenstringliteralcomment) depends on the project.
   So set up it on the local rubocop config manually.
   <sup>[[link](#style-magic-link)]</sup>
 

data/doc/STYLE_GUIDE_RSPEC.md

@@ -16,7 +16,7 @@ This style guide recommends best practices for writing a clear Rspec tests and e
   <sup>[[link](#rspec-nested-groups)]</sup>
 
 * <a name="rspec-subject"></a>
-  Each subject should be named and we should not use `subject` in our test cases.
+  Each subject should be named, and we should not use `subject` in our test cases.
   Prefer to use `is_expected` that `expect(subject_name)` for small tests.
   <sup>[[link](#rspec-subject)]</sup>
 
@@ -60,7 +60,7 @@ end
 ```
 
 * <a name="rspec-example-length"></a>
- A long example is usually more difficult to understand. Consider extracting out some behaviour, e.g. with a `let` block, or a helper method.
+ A long example is usually more difficult to understand. Consider extracting out some behavior, e.g. with a `let` block, or a helper method.
 
   <sup>[[link](#rspec-example-length)]</sup>
 
@@ -153,3 +153,32 @@ end
 ```
 
 **Note:** this is a Part of Rspec configuration. Read more [by link](https://github.com/rubocop-hq/rubocop-rspec#enforcing-an-explicit-rspec-receiver-for-top-level-methods-disabling-monkey-patching).
+
+* <a name="rspec-let-setup"></a>
+  We allow using let! in your test, but suggest not to use it for setting up testing data.
+  <sup>[[link](#rspec-let-setup)]</sup>
+
+```ruby
+# ok
+let!(:my_widget) { create(:widget) }
+
+it "counts widgets" do
+  expect(Widget.count).to eq(1)
+end
+
+# better
+before do
+  create(:widget)
+end
+
+it "counts widgets" do
+  expect(Widget.count).to eq(1)
+end
+
+# good
+let!(:my_widget) { create(:widget) }
+
+it "returns the last widget" do
+  expect(Widget.last).to eq my_widget
+end
+```

data/lib/datarockets/style.rb

@@ -3,6 +3,8 @@ require "datarockets/style/formatter/todo_list_formatter"
 
 require "datarockets/style/version"
 
+require "datarockets/style/cop/layout/array_alignment_extended"
+
 module Datarockets
   # Datarickors sharable config
   module Style

data/lib/datarockets/style/cop/layout/array_alignment_extended.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module Datarockets
+  module Style
+    module Cop
+      module Layout
+        # Here we check if the elements of a multi-line array literal are
+        # aligned.
+        #
+        # @example EnforcedStyle: with_first_argument (default)
+        #   # good
+        #
+        #   array = [1, 2, 3,
+        #            4, 5, 6]
+        #   array = ['run',
+        #            'forrest',
+        #            'run']
+        #
+        #   # bad
+        #
+        #   array = [1, 2, 3,
+        #     4, 5, 6]
+        #   array = ['run',
+        #        'forrest',
+        #        'run']
+        #
+        # @example EnforcedStyle: with_fixed_indentation
+        #   # good
+        #
+        #   array = [1, 2, 3,
+        #     4, 5, 6]
+        #
+        #   # bad
+        #
+        #   array = [1, 2, 3,
+        #            4, 5, 6]
+        class ArrayAlignmentExtended < RuboCop::Cop::Cop
+          include RuboCop::Cop::Alignment
+
+          ALIGN_PARAMS_MSG = "Align the elements of an array literal if they span more " \
+            "than one line."
+
+          FIXED_INDENT_MSG = "Use one level of indentation for elements " \
+            "following the first line of a multi-line array."
+
+          def on_array(node)
+            return if node.children.size < 2
+
+            check_alignment(node.children, base_column(node, node.children))
+          end
+
+          def autocorrect(node)
+            RuboCop::Cop::AlignmentCorrector.correct(processed_source, node, column_delta)
+          end
+
+          private
+
+          def message(_node)
+            fixed_indentation? ? FIXED_INDENT_MSG : ALIGN_PARAMS_MSG
+          end
+
+          def fixed_indentation?
+            cop_config["EnforcedStyle"] == "with_fixed_indentation"
+          end
+
+          def base_column(node, args)
+            if fixed_indentation?
+              lineno = target_method_lineno(node)
+              line = node.source_range.source_buffer.source_line(lineno)
+              indentation_of_line = /\S.*/.match(line).begin(0)
+              indentation_of_line + configured_indentation_width
+            else
+              display_column(args.first.source_range)
+            end
+          end
+
+          def target_method_lineno(node)
+            node.loc.line
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datarockets/style/version.rb

@@ -1,5 +1,5 @@
 module Datarockets
   module Style
-    VERSION = "0.6.2".freeze
+    VERSION = "0.7.0".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datarockets-style
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Roman Dubrovsky
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-06 00:00:00.000000000 Z
+date: 2020-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -48,6 +48,7 @@ files:
 - ".github/ISSUE_TEMPLATE/new-issue.md"
 - ".github/ISSUE_TEMPLATE/update-dependencies.md"
 - ".github/PULL_REQUEST_TEMPLATE.md"
+- ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -57,6 +58,7 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
+- Makefile
 - README.md
 - RELEASING.md
 - Rakefile
@@ -71,6 +73,7 @@ files:
 - doc/STYLE_GUIDE_RAILS.md
 - doc/STYLE_GUIDE_RSPEC.md
 - lib/datarockets/style.rb
+- lib/datarockets/style/cop/layout/array_alignment_extended.rb
 - lib/datarockets/style/formatter/todo_list_formatter.rb
 - lib/datarockets/style/formatter/todo_list_formatter/report_summary.rb
 - lib/datarockets/style/version.rb
@@ -95,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Datarockets style guides and shared style configs