datarockets-style 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a419ac14c8ca4180f3f2e84d995a722129c04d3
-  data.tar.gz: a86d9ed8fc71274bcbb72a8b2834575191aa7876
+  metadata.gz: 0dbec2a9995d6607b63dafed5a123bfdb8704e3a
+  data.tar.gz: 50bee07693998a77cf012e2cff94905095e111fc
 SHA512:
-  metadata.gz: d14ee00d5a5936c01202602e715837df46a2ce514319fc16e59236fbd4332ef8988ac70bf1acfc2953669263d879e25983e1640322ba8ae42fda426c479fde83
-  data.tar.gz: 9c9997bb55e5524e61929feb73933eaf99bfe9d525694cd0a2059f761f697e8922949ae312abb3aac891b26e4b91ec67e4ed638c3bdcbea919d89612e0b89023
+  metadata.gz: b6e5844c8bee41e0c621cf732808284d0f7596f1949c65396ef4dcbbccc830141209f3b1e8865d9e9b59b38ff5e2c36dd8dfe35f38cddfaad74a9f87101d9b33
+  data.tar.gz: '096a00c0585458c1fd3ca87f0b116db3b90588c368e3a4c86dc76f253932516c3b80dd8099f8e09dc810ee4dbc8b14c5b9a7c5e66f0b378245f1eec9174faef9'

data/.github/ISSUE_TEMPLATE/new-issue.md

@@ -0,0 +1,17 @@
+---
+name: New issue or feature request
+about: Suggest a new feature or enhancement, ask a question, report bug, etc.
+title: "Title goes here"
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is.
+
+**Additional context.**
+Add any other context or screenshots about the feature request here.
+
+**Add label.**
+Add label for easier navigation by issues and understanding your expectations.

data/.github/ISSUE_TEMPLATE/update-dependencies.md

@@ -0,0 +1,16 @@
+---
+name: Update Dependencies
+about: Updating dependencies issue
+title: "Update *dependency* to *version*"
+labels: dependencies
+assignees: ''
+
+---
+
+Link to the new release: *link*
+
+To-Do list:
+
+- [ ] update dependencies to the latest version
+- [ ] investigate how it changes and affect our current styles and cops
+- [ ] check the required ruby version

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,10 @@
+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)
+- [ ] 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)
+- [ ] add a note to the changelog file
+- [ ] the commit message contains the number of the related issue (if it presents)
+  and word `Fix` if this PR closes related issue
+- [ ] squash all commits before submitting to review

data/CHANGELOG.md

@@ -1,15 +1,30 @@
 # Change Log
 
-The format is described in [Contributing notes](CONTRIBUTING.md#changelog-entry-format)
+The format is described in [Contributing notes](CONTRIBUTING.md#changelog-entry-format).
 
 ## master (unreleased)
 
+## 0.3.0 (2019-08-02)
+
+### Changed
+
+* Update rubocop to `0.74.0`. ([@r.dubrovsky][])
+* Update rubocop-rspec to `1.34.1`. ([@r.dubrovsky][])
+* Move shared rubocop config into `config` directory. ([@r.dubrovsky][])
+* Allow writing empty methods in two lines. ([@v.kuzmik][])
+* Disable `Style/FrozenStringLiteralComment` cop by default. ([@r.dubrovsky][])
+
+### Fixed
+
+* [#4222](https://github.com/rubocop-hq/rubocop/issues/4222): Disable `Lint/AmbiguousBlockAssociation` for Rspec directory. ([@r.dubrovsky][])
+* [#65](https://github.com/datarockets/datarockets-style/issues/65): Exclude `node_modules` from rubocop scope. ([@r.dubrovsky][])
+
 ## 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][])
+* 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)
@@ -17,24 +32,25 @@ The format is described in [Contributing notes](CONTRIBUTING.md#changelog-entry-
 ### Added
 
 * Base config with community rules and some basic override rules. ([@r.dubrovsky][], [@aleks][])
-* Config is based on rubocop version 0.72.0 ([@r.dubrovsky][])
-* Enable `rubocop-spec` cops by default ([@r.dubrovsky][])
-* Enable `Bundler/DuplicatedGem` cop by default ([@r.dubrovsky][])
-* Enable `Bundler/OrderedGems` cop with allowing ordering by groups ([@r.dubrovsky][])
+* Config is based on rubocop version 0.72.0. ([@r.dubrovsky][])
+* Enable `rubocop-spec` cops by default. ([@r.dubrovsky][])
+* Enable `Bundler/DuplicatedGem` cop by default. ([@r.dubrovsky][])
+* Enable `Bundler/OrderedGems` cop with allowing ordering by groups. ([@r.dubrovsky][])
 
 
 ### Changed
 
-* 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][])
-* 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][])
+* 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][])
+* 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][])
 
 [@r.dubrovsky]: https://github.com/roman-dubrovsky
 [@aleks]: https://github.com/AleksSenkou
 [@ula]: https://github.com/lazycoder9
+[@v.kuzmik]: https://github.com/TheBlackArroVV/

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    datarockets-style (0.2.0)
-      rubocop (~> 0.73.0)
-      rubocop-rspec (~> 1.33)
+    datarockets-style (0.3.0)
+      rubocop (~> 0.74.0)
+      rubocop-rspec (~> 1.34)
 
 GEM
   remote: https://rubygems.org/
@@ -15,14 +15,14 @@ GEM
       ast (~> 2.4.0)
     rainbow (3.0.0)
     rake (10.5.0)
-    rubocop (0.73.0)
+    rubocop (0.74.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
       parser (>= 2.6)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.7)
-    rubocop-rspec (1.33.0)
+    rubocop-rspec (1.34.1)
       rubocop (>= 0.60.0)
     ruby-progressbar (1.10.1)
     unicode-display_width (1.6.0)

data/README.md

@@ -33,7 +33,7 @@ Create a `.rubocop.yml` with the following directives:
 ```yaml
 inherit_gem:
   datarockets-style:
-    - default.yml
+    - config/default.yml
 ```
 
 Now, run:

data/RELEASING.md

@@ -1,17 +1,17 @@
 # Releasing
 
 * Update `version.rb` file accordingly.
-* Update `CHANGELOG.md` file
-* Tag the release: `git tag vVERSION`
-* Push changes: `git push --tags`
-* Update the release notes on GitHub.com
-* Build and publish:
+* Update `CHANGELOG.md` file.
+* Update `Gemfile.lock` file via running `bundle install`.
+* Build and publish (and verify that everything ok):
 
 ```bash
 bundle exec rake build
-gem push *todo*
+gem push *built_file*
 ```
-
+* Tag the release: `git tag vVERSION`.
+* Push changes: `git push --tags`.
+* Update the release notes on GitHub.com.
 * Announce the new release,
    making sure to say "thank you" to the contributors
    who helped shape this version!

data/STYLE_GUIDE.md

@@ -72,33 +72,39 @@ do_something(foo: 1,
   The parameters on a multi-line method call or definition are aligning by an indentation level.
   <sup>[[link](#style-parameters-aligning)]</sup>
 
+  **Recommended:** write each parameter on the separate line.
+
 ```ruby
-# good
+# bad
 
-def foo(bar,
-  baz)
+def foo(bar, baz,
+        kek, lol)
   123
 end
 
+# bad
+
 def foo(
   bar,
-  baz
-)
+     baz)
   123
 end
 
-# bad
+# good
 
-def foo(bar,
-        baz)
+def foo(bar, baz,
+  kek, lol)
   123
 end
 
-# bad
+# better
 
 def foo(
   bar,
-     baz)
+  baz,
+  kek,
+  lol
+)
   123
 end
 ```
@@ -240,6 +246,32 @@ rescue MyException => error
   # do something
 end
 ```
+
+
+* <a name="style-empty-method"></a>
+  Write empty methods in an expanded way.
+  <sup>[[link](#style-empty-method)]</sup>
+
+```ruby
+# bad
+def foo(bar); end
+
+def self.foo(bar); end
+
+# good
+def foo(bar)
+end
+
+def self.foo(bar)
+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>
+
 ## Rspec
 
 * <a name="rspec-betterrspec"></a>

data/{default.yml → config/default.yml}

@@ -4,6 +4,7 @@ AllCops:
     - "bin/*"
     - "lib/tasks/**/*"
     - "config/**/*"
+    - "node_modules/**/*"
     - "vendor/**/*"
     - "app/views/**/*"
     - "config.ru"
@@ -34,6 +35,10 @@ Layout/SpaceInsideHashLiteralBraces:
   EnforcedStyle: no_space
   EnforcedStyleForEmptyBraces: no_space
 
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - "spec/**/*"
+
 Metrics/BlockLength:
   Exclude:
     - "spec/**/*"
@@ -47,5 +52,11 @@ Naming/RescuedExceptionsVariableName:
 RSpec/ImplicitSubject:
   Enabled: false
 
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
 Style/StringLiterals:
   EnforcedStyle: double_quotes

data/datarockets-style.gemspec

@@ -30,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.73.0"
-  spec.add_dependency "rubocop-rspec", "~> 1.33"
+  spec.add_dependency "rubocop", "~> 0.74.0"
+  spec.add_dependency "rubocop-rspec", "~> 1.34"
 
   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.2.0"
+    VERSION = "0.3.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datarockets-style
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Roman Dubrovsky
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-17 00:00:00.000000000 Z
+date: 2019-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.73.0
+        version: 0.74.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.73.0
+        version: 0.74.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.33'
+        version: '1.34'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.33'
+        version: '1.34'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -73,6 +73,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE/new-issue.md"
+- ".github/ISSUE_TEMPLATE/update-dependencies.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
 - ".gitignore"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -86,8 +89,8 @@ files:
 - STYLE_GUIDE.md
 - bin/console
 - bin/setup
+- config/default.yml
 - datarockets-style.gemspec
-- default.yml
 - lib/datarockets/style.rb
 - lib/datarockets/style/version.rb
 homepage: https://github.com/datarockets/datarockets-style