datarockets-style 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0dbec2a9995d6607b63dafed5a123bfdb8704e3a
-  data.tar.gz: 50bee07693998a77cf012e2cff94905095e111fc
+  metadata.gz: 803ec04bc148a97a6a025daedf5fb3b59590bfe8
+  data.tar.gz: 5a55887fbd7d868a061678cd7a26e020e29c82ee
 SHA512:
-  metadata.gz: b6e5844c8bee41e0c621cf732808284d0f7596f1949c65396ef4dcbbccc830141209f3b1e8865d9e9b59b38ff5e2c36dd8dfe35f38cddfaad74a9f87101d9b33
-  data.tar.gz: '096a00c0585458c1fd3ca87f0b116db3b90588c368e3a4c86dc76f253932516c3b80dd8099f8e09dc810ee4dbc8b14c5b9a7c5e66f0b378245f1eec9174faef9'
+  metadata.gz: 23b0c24787daf815f6620a6f9e378c707036f0a928205241740fcb56867d22f7cfd11242f99a99c9bd0d02868a2eef8586a100de83beabae8de2ff64ba0adb87
+  data.tar.gz: b925359074352f9bb255a03054affdf2d9b1c03207148267d7df533a09e6498aab6e1c65d9e7ecdd4b4c973472644f735e6729cfd285e6dc05a00b4199ed1a6b

data/CHANGELOG.md

@@ -4,6 +4,17 @@ The format is described in [Contributing notes](CONTRIBUTING.md#changelog-entry-
 
 ## master (unreleased)
 
+## 0.4.0 (2019-08-13)
+
+### Changed
+
+* Update rubocop-rspec to `1.35.0`. ([@r.dubrovsky][])
+* Use contenxt-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][])
+
 ## 0.3.0 (2019-08-02)
 
 ### Changed

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    datarockets-style (0.3.0)
+    datarockets-style (0.4.0)
       rubocop (~> 0.74.0)
-      rubocop-rspec (~> 1.34)
+      rubocop-rspec (~> 1.35)
 
 GEM
   remote: https://rubygems.org/
@@ -22,7 +22,7 @@ GEM
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.7)
-    rubocop-rspec (1.34.1)
+    rubocop-rspec (1.35.0)
       rubocop (>= 0.60.0)
     ruby-progressbar (1.10.1)
     unicode-display_width (1.6.0)

data/README.md

@@ -44,6 +44,25 @@ $ bundle exec rubocop
 
 You do not need to include rubocop directly in your application's dependencies. Datarockets-style will include a specific version of `rubocop` and `rubocop-rspec` that is shared across all projects.
 
+### Configurable cops
+
+There are some areas in which there is no clear consensus in datarockets team regarding a particular style (like string literal quoting).
+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.
+
+#### 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.
+There is no clear consensus about this style in the Ruby community and in the datarockets team.
+So we suggest just to set up a [preferable style](https://rubocop.readthedocs.io/en/latest/cops_style/#stylestringliterals) before running this gem.
+
+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).
+
+
 ## Changelog
 
 Datarockets Style's changelog is available [here](CHANGELOG.md).

data/STYLE_GUIDE.md

@@ -26,12 +26,13 @@ This is a small list of differences which we have when compared with community s
   Limit lines to 120 characters.
   <sup>[[link](#style-line-length)]</sup>
 
-* <a name="style-double-quotes"></a>
-  Prefer double-quotes unless your string literal contains " or escape characters you want to suppress.
-  <sup>[[link](#style-double-quotes)]</sup>
+* <a name="style-string-quotes"></a>
+  Adopt a consistent string literal quoting style.
+  <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.
+  Also, the first hash key is aligned by an indentation level.
   <sup>[[link](#style-hash-aligning)]</sup>
 
 
@@ -41,22 +42,50 @@ This is a small list of differences which we have when compared with community s
   foo: bar,
    ba: baz
 }
+
 {
   foo: bar,
   ba:  baz
 }
 
+{
+    foo: bar,
+  ba: baz
+}
+
+{
+  foo: {
+         bar: bar,
+         ba: baz
+       }
+}
+
+method_call({
+               its_like: :this
+             })
+
 # good
 {
   foo: bar,
   ba: baz
 }
+
+{
+  foo: {
+    bar: bar,
+    ba: baz
+  }
+}
+
+method_call({
+  no: :difference
+})
 ```
 
-* <a name="style-keyword-arguments-aligning"></a>
-  There is one exception in the rule above when the hash literal is passed as method argument.
-  In this case we just use an indentation level.
-  <sup>[[link](#style-keyword-arguments-aligning)]</sup>
+* <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.
+  <sup>[[link](#style-arguments-aligning)]</sup>
 
 ```ruby
 # bad
@@ -66,6 +95,14 @@ do_something(foo: 1,
 # good
 do_something(foo: 1,
   bar: 2)
+
+# good
+foo :bar,
+  :baz
+
+# bad
+foo :bar,
+    :baz
 ```
 
 * <a name="style-parameters-aligning"></a>
@@ -109,6 +146,35 @@ def foo(
 end
 ```
 
+* <a name="style-multiline-method-call-indentation">
+  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>
+
+```ruby
+# bad
+while myvariable
+      .b
+  # do something
+end
+
+# bad
+Thing.a
+     .b
+     .c
+
+# good
+while myvariable
+  .b
+
+  # do something
+end
+
+# good
+Thing.a
+  .b
+  .c
+```
+
 * <a name="style-end-aligning"></a>
   The `end` shall be aligned with the left-hand-side of the variable assignment. But we prefer not to use code blocks with `end` for variable assignment and prefer move it into the separate methods.
   <sup>[[link](#style-end-aligning)]</sup>
@@ -163,16 +229,16 @@ end
 # bad
 class A
   def test
-    puts 'hello'
-     puts 'world'
+    puts "hello"
+     puts "world"
   end
 end
 
 # bad
 class A
   def test
-    puts 'hello'
-    puts 'world'
+    puts "hello"
+    puts "world"
   end
 
   protected
@@ -189,16 +255,16 @@ end
 # good
 class A
   def test
-    puts 'hello'
-    puts 'world'
+    puts "hello"
+    puts "world"
   end
 end
 
 # good
 class A
   def test
-    puts 'hello'
-    puts 'world'
+    puts "hello"
+    puts "world"
   end
 
   protected
@@ -266,12 +332,48 @@ def self.foo(bar)
 end
 ```
 
+* <a name="style-cached-instance-variable-name"></a>
+  Use leading underscores in cached instance variable name
+  <sup>[[link](#style-cached-instance-variable-name)]</sup>
+
+```ruby
+# bad
+def foo
+  @something ||= calculate_expensive_thing
+end
+
+# bad
+def foo
+  @foo ||= calculate_expensive_thing
+end
+
+# good
+def foo
+  @_foo ||= calculate_expensive_thing
+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.
   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})
+```
+
 ## Rspec
 
 * <a name="rspec-betterrspec"></a>
@@ -291,21 +393,37 @@ end
 # bad
 subject { service.call }
 
-it 'test' do
+it "test" do
   expect(subject).to eq value
 end
 
 # ok
 subject(:service_call) { service.call }
 
-it 'test' do
+it "test" do
   expect(service_call).to eq value
 end
 
 # better
 subject { service.call }
 
-it 'test' do
+it "test" do
   is_expected.to eq value
 end
 ```
+
+* <a name="rspec-context-wording"></a>
+  When describing a context, start its description with "when", "for", with" or "without".
+  <sup>[[link](#rspec-context-wording)]</sup>
+
+```ruby
+  # bad
+context "the display name not present" do
+  # ...
+end
+
+# good
+context "when the display name is not present" do
+  # ...
+end
+```

data/config/default.yml

@@ -18,6 +18,9 @@ Bundler/DuplicatedGem:
 Bundler/OrderedGems:
   TreatCommentsAsGroupSeparators: true
 
+Layout/AlignArguments:
+  EnforcedStyle: with_fixed_indentation
+
 Layout/AlignHash:
   EnforcedLastArgumentHashStyle: always_ignore
 
@@ -31,6 +34,12 @@ Layout/EndAlignment:
 Layout/IndentationConsistency:
   EnforcedStyle: normal
 
+Layout/IndentFirstHashElement:
+  EnforcedStyle: consistent
+
+Layout/MultilineMethodCallIndentation:
+    EnforcedStyle: indented
+
 Layout/SpaceInsideHashLiteralBraces:
   EnforcedStyle: no_space
   EnforcedStyleForEmptyBraces: no_space
@@ -46,12 +55,25 @@ Metrics/BlockLength:
 Metrics/LineLength:
   Max: 120
 
+Naming/MemoizedInstanceVariableName:
+  EnforcedStyleForLeadingUnderscores: required
+
 Naming/RescuedExceptionsVariableName:
   PreferredName: error
 
+RSpec/ContextWording:
+  Prefixes:
+    - when
+    - with
+    - without
+    - for
+
 RSpec/ImplicitSubject:
   Enabled: false
 
+Style/BracesAroundHashParameters:
+  EnforcedStyle: context_dependent
+
 Style/EmptyMethod:
   EnforcedStyle: expanded
 

data/datarockets-style.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "rubocop", "~> 0.74.0"
-  spec.add_dependency "rubocop-rspec", "~> 1.34"
+  spec.add_dependency "rubocop-rspec", "~> 1.35"
 
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/datarockets/style/version.rb

@@ -1,5 +1,5 @@
 module Datarockets
   module Style
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datarockets-style
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Roman Dubrovsky
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-02 00:00:00.000000000 Z
+date: 2019-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.34'
+        version: '1.35'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.34'
+        version: '1.35'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement