datarockets-style 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 803ec04bc148a97a6a025daedf5fb3b59590bfe8
-  data.tar.gz: 5a55887fbd7d868a061678cd7a26e020e29c82ee
+  metadata.gz: b7abb7599f2b6308e1bf7ba21af09f8d6d10658d
+  data.tar.gz: 064e54aa27dbe9e00453ad91eac3dcf7b33592c6
 SHA512:
-  metadata.gz: 23b0c24787daf815f6620a6f9e378c707036f0a928205241740fcb56867d22f7cfd11242f99a99c9bd0d02868a2eef8586a100de83beabae8de2ff64ba0adb87
-  data.tar.gz: b925359074352f9bb255a03054affdf2d9b1c03207148267d7df533a09e6498aab6e1c65d9e7ecdd4b4c973472644f735e6729cfd285e6dc05a00b4199ed1a6b
+  metadata.gz: b751d28c3f3f239d426f2e80f99be7866e1f63562b674175366ca2290e2c8e2cb9a7051abd00a9f3b7b695979ac801556230f7a49f67483ddeaa4fcd7629cf54
+  data.tar.gz: 72db0bda1af9bb3b9ad45c8b57482014a649d453fdc8dc7218293bb9ee9cfa18085488f1c9c8e40b5a8ccc3c809d39ae895d6c91a6159729dc9556e8a6156e43

data/.gitignore

@@ -2,6 +2,5 @@
 /bundler/
 /.yardoc
 /_yardoc/
-/doc/
 /pkg/
 /tmp/

data/CHANGELOG.md

@@ -4,6 +4,20 @@ The format is described in [Contributing notes](CONTRIBUTING.md#changelog-entry-
 
 ## master (unreleased)
 
+## 0.5.0 (2019-10-26)
+
+### Changed
+
+* Split single rubocop config to smaller (for ruby, rails and rspec). ([@r.dubrovsky][])
+* Update rubocop to `0.75.1`.
+* Update rubocop-rspec to `1.36.0`.
+* Use block style for `RSpec/ExpectChange` cop. ([@r.dubrovsky][])
+* Add `RSpec/MessageSpies` cop to style guide. ([@r.dubrovsky][])
+
+### Fixed
+
+* Fix `RSpec/DescribedClass`'s error when `described_class` is used as part of a constant. This is part of rubocop-rspec changes.
+
 ## 0.4.0 (2019-08-13)
 
 ### Changed

data/CONTRIBUTING.md

@@ -27,7 +27,7 @@ do so.
 * If your change has a corresponding open GitHub issue, prefix the commit message with `[Fix #github-issue-number]`.
 * Make sure to add tests for it. This is important so we don't break it
   in a future version unintentionally.
-* If you add new code-style rule or cop, add some words about it in the [Code Style Notes](STYLE_GUIDE.md).
+* If you add new code-style rule or cop, add some words about it in the [Code Style Notes](doc/STYLE_GUIDE.md) or related files.
 * Add an entry to the [Changelog](CHANGELOG.md) accordingly. See [changelog entry format](#changelog-entry-format).
 * If you deliver new cop, try to suggest and deliver it to the community [rubocop][7] gem.
 * [Squash related commits together][5].

data/Gemfile.lock

@@ -1,29 +1,29 @@
 PATH
   remote: .
   specs:
-    datarockets-style (0.4.0)
-      rubocop (~> 0.74.0)
-      rubocop-rspec (~> 1.35)
+    datarockets-style (0.5.0)
+      rubocop (>= 0.74, < 0.76)
+      rubocop-rspec (~> 1.36)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.0)
     jaro_winkler (1.5.3)
-    parallel (1.17.0)
-    parser (2.6.3.0)
+    parallel (1.18.0)
+    parser (2.6.5.0)
       ast (~> 2.4.0)
     rainbow (3.0.0)
-    rake (10.5.0)
-    rubocop (0.74.0)
+    rake (13.0.0)
+    rubocop (0.75.1)
       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.35.0)
-      rubocop (>= 0.60.0)
+    rubocop-rspec (1.36.0)
+      rubocop (>= 0.68.1)
     ruby-progressbar (1.10.1)
     unicode-display_width (1.6.0)
 
@@ -31,9 +31,8 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.16)
   datarockets-style!
-  rake (~> 10.0)
+  rake (~> 13.0)
 
 BUNDLED WITH
    1.16.1

data/README.md

@@ -2,7 +2,7 @@
 
 Datarockets shared style configs and notes of code-style convensions. 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](STYLE_GUIDE.md).
+This config enforces many of the guidelines outlined in the datarockets [Ruby Style Guide](doc/STYLE_GUIDE.md).
 
 ## Installation
 
@@ -30,10 +30,36 @@ $ bundle install
 
 Create a `.rubocop.yml` with the following directives:
 
+
+### Ruby application
+
+This config includes specific rules for Ruby application. It works for Ruby gems and no-Rails applications.
+
+```yaml
+inherit_gem:
+  datarockets-style:
+    - config/ruby.yml
+```
+
+### Rails application
+
+For Rails applications, you can use a specific Rails instead of Ruby config
+
+```yaml
+inherit_gem:
+  datarockets-style:
+    - config/rails.yml
+```
+
+### Rspec config
+
+For Rspec tests, you can add a special rubocop config
+
 ```yaml
 inherit_gem:
   datarockets-style:
-    - config/default.yml
+    - config/ruby.yml
+    - config/rspec.yml
 ```
 
 Now, run:

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

@@ -1,17 +1,3 @@
-AllCops:
-  Exclude:
-    - "db/**/*"
-    - "bin/*"
-    - "lib/tasks/**/*"
-    - "config/**/*"
-    - "node_modules/**/*"
-    - "vendor/**/*"
-    - "app/views/**/*"
-    - "config.ru"
-    - "Rakefile"
-
-require: rubocop-rspec
-
 Bundler/DuplicatedGem:
   Enabled: true
 
@@ -44,14 +30,6 @@ Layout/SpaceInsideHashLiteralBraces:
   EnforcedStyle: no_space
   EnforcedStyleForEmptyBraces: no_space
 
-Lint/AmbiguousBlockAssociation:
-  Exclude:
-    - "spec/**/*"
-
-Metrics/BlockLength:
-  Exclude:
-    - "spec/**/*"
-
 Metrics/LineLength:
   Max: 120
 
@@ -61,16 +39,6 @@ Naming/MemoizedInstanceVariableName:
 Naming/RescuedExceptionsVariableName:
   PreferredName: error
 
-RSpec/ContextWording:
-  Prefixes:
-    - when
-    - with
-    - without
-    - for
-
-RSpec/ImplicitSubject:
-  Enabled: false
-
 Style/BracesAroundHashParameters:
   EnforcedStyle: context_dependent
 

data/config/rails.yml

@@ -0,0 +1,13 @@
+AllCops:
+  Exclude:
+    - "db/**/*"
+    - "bin/*"
+    - "lib/tasks/**/*"
+    - "config/**/*"
+    - "node_modules/**/*"
+    - "vendor/**/*"
+    - "app/views/**/*"
+    - "config.ru"
+    - "Rakefile"
+
+inherit_from: base.yml

data/config/rspec.yml

@@ -0,0 +1,25 @@
+require: rubocop-rspec
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - "spec/**/*"
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"
+
+RSpec/ContextWording:
+  Prefixes:
+    - when
+    - with
+    - without
+    - for
+
+RSpec/ExpectChange:
+  EnforcedStyle: block
+
+RSpec/ImplicitSubject:
+  Enabled: false
+
+RSpec/MessageSpies:
+  EnforcedStyle: have_received

data/config/ruby.yml

@@ -0,0 +1,9 @@
+AllCops:
+  Exclude:
+    - "bin/*"
+    - "lib/tasks/**/*"
+    - "vendor/**/*"
+    - "config.ru"
+    - "Rakefile"
+
+inherit_from: base.yml

data/datarockets-style.gemspec

@@ -30,9 +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.74.0"
-  spec.add_dependency "rubocop-rspec", "~> 1.35"
+  spec.add_dependency "rubocop", ">= 0.74", "< 0.76"
+  spec.add_dependency "rubocop-rspec", "~> 1.36"
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
 end

data/{STYLE_GUIDE.md → doc/STYLE_GUIDE.md}

@@ -2,6 +2,11 @@
 
 In datarockets we enforce a community [Ruby Style Guide](https://github.com/rubocop-hq/ruby-style-guide).
 
+Also, we have some new rules for writing Rails applications and Rspec test. You can find it by next links:
+
+- [Rails Style Guide](doc/STYLE_GUIDE_RAILS.md)
+- [Rspec Style Guide](doc/STYLE_GUIDE_RSPEC.md)
+
 This is a small list of differences which we have when compared with community style guide:
 
 ## Table of contents
@@ -373,57 +378,3 @@ some_method(x, y, {a: 1, b: 2}, a: 1, b: 2)
 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>
-  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>
-
-```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
-```
-
-* <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/doc/STYLE_GUIDE_RAILS.md

@@ -0,0 +1,9 @@
+# Rails Style Guide
+
+This style is based on rules from [Ruby Style Guide](docs/STYLE_GUIDE.md). Also, we enforce rules from [community Rails Style Guide][1].
+
+This is a small list of differences which we have when compared with community and our Ruby style guides:
+
+## TODO
+
+[1]: https://github.com/rubocop-hq/rails-style-guide

data/doc/STYLE_GUIDE_RSPEC.md

@@ -0,0 +1,81 @@
+# Rspec Style Guide
+
+This style guide recommends best practices for writing a clear Rspec tests and enjoy this process.
+
+* <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>
+
+```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
+```
+
+* <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
+```
+
+* <a name="rspec-expect-change"></a>
+  Prefer using blocks for change matcher than method calls.
+  <sup>[[link](#rspec-expect-change)]</sup>
+
+```ruby
+# bad
+expect { run }.to change(Foo, :bar)
+
+# good
+expect { run }.to change { Foo.bar }
+```
+
+* <a name="rspec-message-spies"></a>
+  Check spies messages post-factum (after calling some methods).
+  <sup>[[link](#rspec-message-spies)]</sup>
+
+```ruby
+# bad
+expect(foo).to receive(:bar)
+foo.bar
+
+# good
+foo.bar
+expect(foo).to have_received(:bar)
+```

data/lib/datarockets/style/version.rb

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

metadata

@@ -1,71 +1,63 @@
 --- !ruby/object:Gem::Specification
 name: datarockets-style
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Roman Dubrovsky
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-13 00:00:00.000000000 Z
+date: 2019-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.74'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.74.0
+        version: '0.76'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.74'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.74.0
+        version: '0.76'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.35'
+        version: '1.36'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.35'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '1.36'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 description: 
 email:
 - r.dubrovsky@datarockets.com
@@ -86,11 +78,16 @@ files:
 - README.md
 - RELEASING.md
 - Rakefile
-- STYLE_GUIDE.md
 - bin/console
 - bin/setup
-- config/default.yml
+- config/base.yml
+- config/rails.yml
+- config/rspec.yml
+- config/ruby.yml
 - datarockets-style.gemspec
+- doc/STYLE_GUIDE.md
+- doc/STYLE_GUIDE_RAILS.md
+- doc/STYLE_GUIDE_RSPEC.md
 - lib/datarockets/style.rb
 - lib/datarockets/style/version.rb
 homepage: https://github.com/datarockets/datarockets-style