datarockets-style 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4344b6ab0459c0d422d77d2138d4fdd459ec65e4
-  data.tar.gz: 74cde7a5b535323c47c0ac6670fe79b3a803a27b
+  metadata.gz: f2fd6f40031f396d111c19513fa8e0af187c19ce
+  data.tar.gz: ed7157fb4be39d3c0d62bd3f57cd03fcacf04c12
 SHA512:
-  metadata.gz: 89939e5bf7174b4be6c2cee93d9d19d26232cb034b19818a6bf2ac87cf557f39cf72834c67a812edd92845cf757e97eb51faf9f668484a0d3a38baa72757432a
-  data.tar.gz: da83a217a19f55e2721f496cc1de35d752cc1699e52f9b5a7557986d67b5e43eadd0ecb6e4c300795f6c67f35d2aff4cca8bab7417b65b0feaa8538a8385959b
+  metadata.gz: 7c357e907de9be6791e57a7917597b4d25007e47dadebef87af8d4a2677bf93f39d21217da4710d4aef2efc55834839ff3b26249a24ae3f2eb9c66beca41770c
+  data.tar.gz: e07b9b1d21dc783acf09448ab43a4a78abd8235ec0b03bdfca8ba104aea53650492c873df493f85cf5a64e84b4820e8f5fe57663fde956ec41e5a7a7a5c52343

data/.rubocop.yml

@@ -8,3 +8,8 @@ inherit_mode:
 
 AllCops:
   TargetRubyVersion: 2.3
+
+# for checking cops with interpolation
+Lint/InterpolationCheck:
+  Exclude:
+    - 'spec/**/*.rb'

data/CHANGELOG.md

@@ -4,6 +4,27 @@ The format is described in [Contributing notes](CONTRIBUTING.md#changelog-entry-
 
 ## master (unreleased)
 
+## 0.8.0 (2020-02-20)
+
+### Added
+
+* Add `Style/NestedInterpolation` cop. ([@r.dubrovsky][])
+
+### Changed
+
+* Update rubocop to `0.80.0`. ([@r.dubrovsky][])
+  * Add `Style/HashEachMethods`, `Style/HashTransformKey`, `Style/HashTransformValues` cops.
+  * [#7641](https://github.com/rubocop-hq/rubocop/issues/7641): Remove `Style/BracesAroundHashParameters` cop.
+
+* Update rubocop-rspec to `1.38.1`.
+  * Add RSpec/RepeatedExampleGroupBody cop. ([@ula][])
+  * Add RSpec/RepeatedExampleGroupDescription cop. ([@ula][])
+
+* Enable `rubocop-rails` cops for rails config. ([@ula][])
+* Setup `Style/Documentation` for rails config. ([@r.dubrovsky][])
+* Setup `Style/ClassAndModuleChildren` cop. ([@r.dubrovsky][])
+* Enable `RSpec/LetSetup` cop. ([@r.dubrovsky][])
+
 ## 0.7.0 (2020-01-27)
 
 ### Added

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    datarockets-style (0.7.0)
-      rubocop (~> 0.76)
-      rubocop-rspec (~> 1.36)
+    datarockets-style (0.8.0)
+      rubocop (~> 0.80)
+      rubocop-rails (~> 2.4)
+      rubocop-rspec (~> 1.38)
 
 GEM
   remote: https://rubygems.org/
@@ -23,8 +24,10 @@ GEM
     pry-byebug (3.7.0)
       byebug (~> 11.0)
       pry (~> 0.10)
+    rack (2.2.2)
     rainbow (3.0.0)
     rake (13.0.1)
+    rexml (3.2.4)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -38,14 +41,18 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.0)
-    rubocop (0.79.0)
+    rubocop (0.80.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
       parser (>= 2.7.0.1)
       rainbow (>= 2.2.2, < 4.0)
+      rexml
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.7)
-    rubocop-rspec (1.37.1)
+    rubocop-rails (2.4.2)
+      rack (>= 1.1)
+      rubocop (>= 0.72.0)
+    rubocop-rspec (1.38.1)
       rubocop (>= 0.68.1)
     ruby-progressbar (1.10.1)
     unicode-display_width (1.6.1)

data/README.md

@@ -76,6 +76,11 @@ There are some areas in which there is no clear consensus in datarockets team re
 In such scenarios, all popular styles are acknowledged and it’s up to you to pick one and apply it consistently.
 For that just set up these cops before starting of usage.
 
+#### RSpec/LetSetup
+
+[This cop](https://rubocop-rspec.readthedocs.io/en/latest/cops_rspec/#rspecletsetup) is enabled by default and we suggest not to use unreferenced `let` variables in your test cases.
+However, if it feels like the cop should be enabled and tests can't be written w/o them, please create an issue with your cases so that we can re-thinking our solution about enabling this cop.
+
 #### Style/StringLiterals
 
 There are two popular styles in the Ruby community, both of which are considered good - single quotes by default and double quotes by default.
@@ -88,6 +93,10 @@ P.S. The string literals in this gem are using double quotes by default.
 
 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).
 
+### Custom cops
+
+We have custom cops. You can find specification for them [here](manual).
+
 ## Formatters
 
 ### ToDo list formatter

data/config/base.yml

@@ -16,28 +16,12 @@ 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
 
@@ -70,14 +54,26 @@ Naming/MemoizedInstanceVariableName:
 Naming/RescuedExceptionsVariableName:
   PreferredName: error
 
-Style/BracesAroundHashParameters:
-  EnforcedStyle: context_dependent
+Style/ClassAndModuleChildren:
+  EnforcedStyle: nested
 
 Style/EmptyMethod:
   EnforcedStyle: expanded
 
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
 Style/FrozenStringLiteralComment:
   Enabled: false
 
+Style/NestedInterpolation:
+  Enabled: true
+
 Style/StringLiterals:
   EnforcedStyle: double_quotes

data/config/rails.yml

@@ -1,3 +1,5 @@
+require: rubocop-rails
+
 AllCops:
   Exclude:
     - "db/**/*"
@@ -11,3 +13,8 @@ AllCops:
     - "Rakefile"
 
 inherit_from: base.yml
+
+Style/Documentation:
+  Enabled: true
+  Exclude:
+    - "app/**/*"

data/config/rspec.yml

@@ -26,7 +26,7 @@ RSpec/ImplicitSubject:
   Enabled: false
 
 RSpec/LetSetup:
-  Enabled: false
+  Enabled: true
 
 RSpec/MessageSpies:
   EnforcedStyle: have_received

data/datarockets-style.gemspec

@@ -30,6 +30,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "rubocop", "~> 0.76"
-  spec.add_dependency "rubocop-rspec", "~> 1.36"
+  spec.add_dependency "rubocop", "~> 0.80"
+  spec.add_dependency "rubocop-rails", "~> 2.4"
+  spec.add_dependency "rubocop-rspec", "~> 1.38"
 end

data/doc/STYLE_GUIDE.md

@@ -35,6 +35,19 @@ This is a small list of differences which we have when compared with community s
   Adopt a consistent string literal quoting style.
   <sup>[[link](#style-string-quotes)]</sup>
 
+* <a name="style-nested-interpolation"></a>
+  Avoid using nested interpolation.
+   <sup>[[link](#style-nested-interpolation)]</sup>
+
+```ruby
+# bad
+"Hello, #{user.blank? ? 'guest' : "dear #{user.name}"}"
+
+# good
+user_name = user.blank? ? 'guest' : "dear #{user.name}"
+"Hello, #{user_name}"
+```
+
 * <a name="style-hash-aligning"></a>
   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.
@@ -384,18 +397,3 @@ end
   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>
-
-* <a name="style-braces-around-hash-params"></a>
-  Not to use braces around the last hash literal parameter.
-  But requires braces if the second to last parameter is also a hash literal.
-  <sup>[[link](#style-braces-around-hash-params)]</sup>
-
-```ruby
-# bad
-some_method(x, y, {a: 1, b: 2})
-some_method(x, y, {a: 1, b: 2}, a: 1, b: 2)
-
-# good
-some_method(x, y, a: 1, b: 2)
-some_method(x, y, {a: 1, b: 2}, {a: 1, b: 2})
-```

data/doc/STYLE_GUIDE_RAILS.md

@@ -4,6 +4,32 @@ This style is based on rules from [Ruby Style Guide](docs/STYLE_GUIDE.md). Also,
 
 This is a small list of differences which we have when compared with community and our Ruby style guides:
 
-## TODO
+## Table of contents
+
+* [Style](#Style)
+
+## Style
+
+* <a name="documentation"></a>
+  Documentation is requeried for all files except `app` directory.
+  <sup>[[link](#documentation)]</sup>
+
+* <a name="nested-style-and-modules"></a>
+  Prefer to use nested style of children definitions at classes and modules.
+  <sup>[[link](#nested-style-and-modules)]</sup>
+
+```ruby
+# bad
+class Api::V1::UsersController
+end
+
+# good
+module Api
+  module V1
+    class UsersController
+    end
+  end
+end
+```
 
 [1]: https://github.com/rubocop-hq/rails-style-guide

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

@@ -37,8 +37,7 @@ module Datarockets
         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."
+          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."
@@ -64,14 +63,14 @@ module Datarockets
           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
+            fixed_indentation? ? line_indentation(node) : display_column(args.first.source_range)
+          end
+
+          def line_indentation(node)
+            lineno = target_method_lineno(node)
+            line = node.source_range.source_buffer.source_line(lineno)
+            line_indentation = /\S.*/.match(line).begin(0)
+            line_indentation + configured_indentation_width
           end
 
           def target_method_lineno(node)

data/lib/datarockets/style/cop/style/nested_interpolation.rb

@@ -0,0 +1,37 @@
+module Datarockets
+  module Style
+    module Cop
+      module Style
+        # This cop checks nested interpolations
+        #
+        # @example
+        #
+        # # bad
+        # "Hello, #{user.blank? ? 'guest' : "dear #{user.name}"}"
+        #
+        # # good
+        # user_name = user.blank? ? 'guest' : "dear #{user.name}"
+        # "Hello, #{user_name}"
+        class NestedInterpolation < RuboCop::Cop::Cop
+          include RuboCop::Cop::Interpolation
+
+          MSG = "Redundant nested interpolation.".freeze
+
+          def on_interpolation(node)
+            node.each_descendant(:dstr) do |descendant_node|
+              detect_double_interpolation(descendant_node)
+            end
+          end
+
+          private
+
+          def detect_double_interpolation(node)
+            node.each_child_node(:begin) do |begin_node|
+              add_offense(begin_node)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datarockets/style/version.rb

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

data/lib/datarockets/style.rb

@@ -4,6 +4,7 @@ require "datarockets/style/formatter/todo_list_formatter"
 require "datarockets/style/version"
 
 require "datarockets/style/cop/layout/array_alignment_extended"
+require "datarockets/style/cop/style/nested_interpolation"
 
 module Datarockets
   # Datarickors sharable config

data/manual/cops_layout.md

@@ -0,0 +1,74 @@
+# Layout
+
+## Layout/ArrayAlignmentExtended
+
+Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+--- | --- | --- | --- | ---
+Enabled | Yes | Yes  | 0.7.0 | -
+
+Here we check if the elements of a multi-line array literal are
+aligned.
+
+### Examples
+
+#### EnforcedStyle: with_fixed_indentation (default)
+
+```ruby
+# good
+
+array = [1, 2, 3,
+  4, 5, 6]
+
+# bad
+
+array = [1, 2, 3,
+         4, 5, 6]
+```
+
+#### EnforcedStyle: with_first_argument
+
+```ruby
+# good
+
+array = [1, 2, 3,
+         4, 5, 6]
+array = ['run',
+         'forrest',
+         'run']
+
+# bad
+
+array = [1, 2, 3,
+  4, 5, 6]
+array = ['run',
+     'forrest',
+     'run']
+```
+
+### Configurable attributes
+
+Name | Default value | Configurable values
+--- | --- | ---
+EnforcedStyle | `with_first_parameter` | `with_first_parameter`, `with_fixed_indentation`
+IndentationWidth | `<none>` | Integer
+
+# Style
+
+## Style/NestedInterpolation
+
+Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+--- | --- | --- | --- | ---
+Enabled | Yes | No | 0.8.0 | -
+
+This cop checks nested interpolations
+
+### Example
+
+```ruby
+# bad
+"Hello, #{user.blank? ? 'guest' : "dear #{user.name}"}"
+
+# good
+user_name = user.blank? ? 'guest' : "dear #{user.name}"
+"Hello, #{user_name}"
+```

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datarockets-style
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Roman Dubrovsky
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-27 00:00:00.000000000 Z
+date: 2020-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -16,28 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.76'
+        version: '0.80'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.76'
+        version: '0.80'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.36'
+        version: '1.38'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.36'
+        version: '1.38'
 description: 
 email:
 - r.dubrovsky@datarockets.com
@@ -74,9 +88,11 @@ files:
 - doc/STYLE_GUIDE_RSPEC.md
 - lib/datarockets/style.rb
 - lib/datarockets/style/cop/layout/array_alignment_extended.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
 - lib/datarockets/style/version.rb
+- manual/cops_layout.md
 homepage: https://github.com/datarockets/datarockets-style
 licenses:
 - MIT