datarockets-style 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 324883d55397473999caa61fc8ede9378a4fad7e
-  data.tar.gz: 7baac97267430faabd884999ade8340189e0e32f
+  metadata.gz: 1a419ac14c8ca4180f3f2e84d995a722129c04d3
+  data.tar.gz: a86d9ed8fc71274bcbb72a8b2834575191aa7876
 SHA512:
-  metadata.gz: e3e7980949ee6b086ff587485378546b935b69b105874e1a043eb648fa5db66f212ef12d5ba5b6a9d0f3c7d13a7677d0abf77d0c983c0bcda261e25a1372a010
-  data.tar.gz: df7210852291e82002373257e0dce1c5baf1c87b4051003835bac2e0a7903193101625ee7d4b1a9f83cbef9c2189c7b4c96b6487346d626da47a03f7a055e621
+  metadata.gz: d14ee00d5a5936c01202602e715837df46a2ce514319fc16e59236fbd4332ef8988ac70bf1acfc2953669263d879e25983e1640322ba8ae42fda426c479fde83
+  data.tar.gz: 9c9997bb55e5524e61929feb73933eaf99bfe9d525694cd0a2059f761f697e8922949ae312abb3aac891b26e4b91ec67e4ed638c3bdcbea919d89612e0b89023

data/CHANGELOG.md

@@ -4,6 +4,14 @@ The format is described in [Contributing notes](CONTRIBUTING.md#changelog-entry-
 
 ## master (unreleased)
 
+## 0.2.0 (2019-07-17)
+
+### Changed
+
+* Update rubocop to `0.73.0`. ([@r.dubrovsky][])
+* Use prefered variable name in rescued exceptions (cop: `Naming/RescuedExceptionsVariableName`) ([@ula][])
+* Disable `RSpec/ImplicitSubject` cop for rspec files. ([@r.dubrovsky][])
+
 ## 0.1.0 (2019-06-27)
 
 ### Added
@@ -29,3 +37,4 @@ The format is described in [Contributing notes](CONTRIBUTING.md#changelog-entry-
 
 [@r.dubrovsky]: https://github.com/roman-dubrovsky
 [@aleks]: https://github.com/AleksSenkou
+[@ula]: https://github.com/lazycoder9

data/CONTRIBUTING.md

@@ -19,7 +19,7 @@ do so.
 ## Pull requests
 
 * Read [how to properly contribute to open source projects on GitHub][2].
-* Fork the project.
+* Fork the project (if it's necessary and you don't have writing access).
 * Use a topic/feature branch to easily amend a pull request later, if necessary.
 * Write [good commit messages][3].
 * Use the same coding conventions as the rest of the project.

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    datarockets-style (0.1.0)
-      rubocop (~> 0.72.0)
-      rubocop-rspec
+    datarockets-style (0.2.0)
+      rubocop (~> 0.73.0)
+      rubocop-rspec (~> 1.33)
 
 GEM
   remote: https://rubygems.org/
@@ -15,7 +15,7 @@ GEM
       ast (~> 2.4.0)
     rainbow (3.0.0)
     rake (10.5.0)
-    rubocop (0.72.0)
+    rubocop (0.73.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
       parser (>= 2.6)

data/README.md

@@ -1,4 +1,4 @@
-# Datarockets::Style
+# 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.
 
@@ -22,7 +22,9 @@ spec.add_development_dependency 'datarockets-style'
 
 And then execute:
 
+```bash
 $ bundle install
+```
 
 ## Usage
 

data/STYLE_GUIDE.md

@@ -4,19 +4,35 @@ In datarockets we enforce a community [Ruby Style Guide](https://github.com/rubo
 
 This is a small list of differences which we have when compared with community style guide:
 
+## Table of contents
+
+* [Bundler](#Bundler)
+* [Style](#Style)
+* [Rspec](#Rspec)
+
 ## Bundler
 
-* A Gem's requirements should be listed only once in a Gemfile
+* <a name="bundler-add-once"></a>
+  A Gem's requirements should be listed only once in a Gemfile
+  <sup>[[link](#bundler-add-once)]</sup>
 
-* Gems should be alphabetically sorted within groups. Also you can use a line comment as a group separator.
+* <a name="bundler-ordering"></a>
+  Gems should be alphabetically sorted within groups. Also you can use a line comment as a group separator.
+  <sup>[[link](#bundler-ordering)]</sup>
 
 ## Style
 
-* Limit lines to 80 characters.
+* <a name="style-line-length"></a>
+  Limit lines to 120 characters.
+  <sup>[[link](#style-line-length)]</sup>
 
-* Prefer double-quotes unless your string literal contains " or escape characters you want to suppress.
+* <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>
 
-* If elements of a hash literal span more than one line we're aligning them by keys
+* <a name="style-hash-aligning"></a>
+  If elements of a hash literal span more than one line we're aligning them by keys.
+  <sup>[[link](#style-hash-aligning)]</sup>
 
 
 ```ruby
@@ -37,8 +53,10 @@ This is a small list of differences which we have when compared with community s
 }
 ```
 
-* 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.
+* <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>
 
 ```ruby
 # bad
@@ -50,7 +68,9 @@ do_something(foo: 1,
   bar: 2)
 ```
 
-* The parameters on a multi-line method call or definition are aligning by an indentation level.
+* <a name="style-parameters-aligning"></a>
+  The parameters on a multi-line method call or definition are aligning by an indentation level.
+  <sup>[[link](#style-parameters-aligning)]</sup>
 
 ```ruby
 # good
@@ -83,7 +103,9 @@ def foo(
 end
 ```
 
-* 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.
+* <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>
 
 ```ruby
 # bad
@@ -127,7 +149,9 @@ end
 
 ```
 
-* 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)
+* <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).
+  <sup>[[link](#style-method-indentations)]</sup>
 
 ```ruby
 # bad
@@ -183,7 +207,9 @@ class A
 end
 ```
 
-* 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.
+* <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.
+  <sup>[[link](#style-hash-spaces)]</sup>
 
 ```ruby
 # bad
@@ -195,8 +221,59 @@ h = {a: 1, b: 2}
 Array.new(3) { |i| i + 1 }
 ```
 
+* <a name="style-rescued-variable-name"></a>
+  Use `error` as a variable name on processing exceptions.
+  <sup>[[link](#style-rescued-variable-name)]</sup>
+
+```ruby
+# bad
+begin
+  # do something
+rescue MyException => e
+  # do something
+end
+
+# good
+begin
+  # do something
+rescue MyException => error
+  # do something
+end
+```
 ## Rspec
 
-* We're happy to use [better spec rules](http://www.betterspecs.org/) for improving our tests.
+* <a name="rspec-betterrspec"></a>
+  We're happy to use [better spec rules](http://www.betterspecs.org/) for improving our tests.
+  <sup>[[link](#rspec-betterrspec)]</sup>
+
+* <a name="rspec-file-length"></a>
+  We're not limiting a length of rspec files.
+  <sup>[[link](#rspec-file-length)]</sup>
+
+* <a name="rspec-subject"></a>
+  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>
 
-* We're not limiting a length of rspec files
+```ruby
+# bad
+subject { service.call }
+
+it 'test' do
+  expect(subject).to eq value
+end
+
+# ok
+subject(:service_call) { service.call }
+
+it 'test' do
+  expect(service_call).to eq value
+end
+
+# better
+subject { service.call }
+
+it 'test' do
+  is_expected.to eq value
+end
+```

data/datarockets-style.gemspec

@@ -12,6 +12,8 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/datarockets/datarockets-style"
   spec.license       = "MIT"
 
+  spec.required_ruby_version = '>= 2.3.0'
+
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
   if spec.respond_to?(:metadata)
@@ -28,8 +30,8 @@ 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.72.0"
-  spec.add_dependency "rubocop-rspec"
+  spec.add_dependency "rubocop", "~> 0.73.0"
+  spec.add_dependency "rubocop-rspec", "~> 1.33"
 
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"

data/default.yml

@@ -41,5 +41,11 @@ Metrics/BlockLength:
 Metrics/LineLength:
   Max: 120
 
+Naming/RescuedExceptionsVariableName:
+  PreferredName: error
+
+RSpec/ImplicitSubject:
+  Enabled: false
+
 Style/StringLiterals:
   EnforcedStyle: double_quotes

data/lib/datarockets/style/version.rb

@@ -1,5 +1,5 @@
 module Datarockets
   module Style
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datarockets-style
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Roman Dubrovsky
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-27 00:00:00.000000000 Z
+date: 2019-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.72.0
+        version: 0.73.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.72.0
+        version: 0.73.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.33'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.33'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -103,7 +103,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="