datarockets-style 0.9.0 → 1.2.0

data/doc/STYLE_GUIDE.md

@@ -392,6 +392,126 @@ def foo
 end
 ```
 
+* <a name="style-trailing-comma-in-arguments"></a>
+  Requires a comma after the last argument, but only for parenthesized method calls where each argument is on its own line.
+  <sup>[[link](#style-trailing-comma-in-arguments)]</sup>
+
+```ruby
+# bad
+method(1, 2,)
+
+# good
+method(1, 2)
+
+# bad
+method(
+  1, 2,
+  3,
+)
+
+# good
+method(
+  1, 2,
+  3
+)
+
+# bad
+method(
+  1, 2, 3,
+)
+
+# good
+method(
+  1, 2, 3
+)
+
+# good
+method(
+  1,
+  2,
+)
+```
+
+* <a name="style-trailing-comma-in-array-literals"></a>
+  Requires a comma after last item in an array, but only when each item is on its own line.
+  <sup>[[link](#style-trailing-comma-in-array-literals)]</sup>
+
+```ruby
+# bad
+a = [1, 2,]
+
+# good
+a = [1, 2]
+
+# bad
+a = [
+  1, 2,
+  3,
+]
+
+# good
+a = [
+  1, 2,
+  3
+]
+
+# bad
+a = [
+  1, 2, 3,
+]
+
+# good
+a = [
+  1, 2, 3
+]
+
+# good
+a = [
+  1,
+  2,
+]
+```
+
+* <a name="style-trailing-comma-in-hash-literal"></a>
+  Requires a comma after the last item in a hash.
+  <sup>[[link](#style-trailing-comma-in-hash-literal)]</sup>
+
+```ruby
+# bad
+a = { foo: 1, bar: 2, }
+
+# good
+a = { foo: 1, bar: 2 }
+
+# bad
+a = {
+  foo: 1, bar: 2,
+  qux: 3,
+}
+
+# good
+a = {
+  foo: 1, bar: 2,
+  qux: 3
+}
+
+# bad
+a = {
+  foo: 1, bar: 2, qux: 3,
+}
+
+# good
+a = {
+  foo: 1, bar: 2, qux: 3
+}
+
+# good
+a = {
+  foo: 1,
+  bar: 2,
+}
+```
+
 * <a name="style-magic-link"></a>
   There are not any required rules for `frozen_string_literal` magic url.
   Set up [this cop](https://rubocop.readthedocs.io/en/latest/cops_style/#stylefrozenstringliteralcomment) depends on the project.

data/doc/STYLE_GUIDE_RSPEC.md

@@ -15,6 +15,10 @@ This style guide recommends best practices for writing a clear Rspec tests and e
   So there are not any limits for deep or nested groups.
   <sup>[[link](#rspec-nested-groups)]</sup>
 
+* <a name="rspec-let-count"></a>
+  We're not limiting a number of `let` blocks in describe and context blocks.
+  <sup>[[link](#rspec-let-count)]</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.
@@ -182,3 +186,19 @@ it "returns the last widget" do
   expect(Widget.last).to eq my_widget
 end
 ```
+
+* <a name="rspec-prefer-before"></a>
+  Prefer using `before` instead of `setup`.
+  <sup>[[link](#rspec-prefer-before)]</sup>
+
+```ruby
+# bad
+setup do
+  allow(post).to receive(:publish!)
+end
+
+# good
+before do
+  allow(post).to receive(:publish!)
+end
+```

data/lib/datarockets_style.rb

@@ -0,0 +1,13 @@
+require "rubocop"
+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"
+require "datarockets_style/cop/rspec/prefer_before_over_setup"
+
+# Top level module for datarockets-style
+module DatarocketsStyle
+  # Datarickors sharable config
+end

data/lib/datarockets_style/cop/layout/array_alignment_extended.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module DatarocketsStyle
+  module Cop
+    module Layout
+      # Here we check if the elements of a multi-line array literal are
+      # aligned.
+      #
+      # @example EnforcedStyle: with_first_argument (default)
+      #   # good
+      #
+      #   array = [1, 2, 3,
+      #            4, 5, 6]
+      #   array = ['run',
+      #            'forrest',
+      #            'run']
+      #
+      #   # bad
+      #
+      #   array = [1, 2, 3,
+      #     4, 5, 6]
+      #   array = ['run',
+      #        'forrest',
+      #        'run']
+      #
+      # @example EnforcedStyle: with_fixed_indentation
+      #   # good
+      #
+      #   array = [1, 2, 3,
+      #     4, 5, 6]
+      #
+      #   # bad
+      #
+      #   array = [1, 2, 3,
+      #            4, 5, 6]
+      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."
+
+        FIXED_INDENT_MSG = "Use one level of indentation for elements " \
+            "following the first line of a multi-line array."
+
+        def on_array(node)
+          return if node.children.size < 2
+
+          check_alignment(node.children, base_column(node, node.children))
+        end
+
+        def autocorrect(node)
+          RuboCop::Cop::AlignmentCorrector.correct(processed_source, node, column_delta)
+        end
+
+        private
+
+        def message(_node)
+          fixed_indentation? ? FIXED_INDENT_MSG : ALIGN_PARAMS_MSG
+        end
+
+        def fixed_indentation?
+          cop_config["EnforcedStyle"] == "with_fixed_indentation"
+        end
+
+        def base_column(node, args)
+          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)
+          node.loc.line
+        end
+      end
+    end
+  end
+end

data/lib/datarockets_style/cop/rspec/prefer_before_over_setup.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module DatarocketsStyle
+  module Cop
+    module RSpec
+      # Checks that tests use `before` instead of RoR unit-test `setup` method (part of `rspec-rails` gem)
+      #
+      # bad
+      #
+      # setup do
+      #   allow(post).to receive(:publish!)
+      # end
+      #
+      # good
+      #
+      # before do
+      #   allow(post).to receive(:publish!)
+      # end
+      class PreferBeforeOverSetup < RuboCop::Cop::Cop
+        MSG = "Use `before` instead of `setup`."
+
+        def_node_matcher :setup_call?, <<-PATTERN
+          (block
+            (send _ :setup)
+            (args) _)
+        PATTERN
+
+        def on_block(node)
+          return unless setup_call?(node)
+
+          add_offense(node)
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            block_internals = node.source.split(/ /)
+            corrector.replace node.loc.expression, ["before", *block_internals[1..-1]].join(" ")
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+module DatarocketsStyle
+  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

data/lib/{datarockets/style → datarockets_style}/formatter/todo_list_formatter.rb

@@ -42,9 +42,10 @@ class TodoListFormatter < RuboCop::Formatter::ProgressFormatter
   def finished(inspected_files)
     report_summary(inspected_files.length,
       @total_offense_count,
-      @total_correction_count)
+      @total_correction_count,
+      @total_correctable_count)
     output.puts
 
-    Datarockets::Style::Formatter::TodoListFormatter::ReportSummary.new(offense_list).call(output)
+    DatarocketsStyle::Formatter::TodoListFormatter::ReportSummary.new(offense_list).call(output)
   end
 end

data/lib/datarockets_style/formatter/todo_list_formatter/report_summary.rb

@@ -0,0 +1,55 @@
+module DatarocketsStyle
+  module Formatter
+    module TodoListFormatter
+      # Get file of pairs: file path and cop name - and prepare report for ToDo list formatter.
+      #
+      # Example of result:
+      #
+      # LineLength
+      #   Exclude:
+      #     - "really/bad/file.rb" # 100500
+      #     - "almost/ok.rb" # 1
+      class ReportSummary
+        attr_reader :offense_list
+
+        FileGroup = Struct.new(:file, :offenses_count) do
+          def print(output)
+            output.puts "    - '#{file}' # #{offenses_count}"
+          end
+        end
+
+        OffenseGroup = Struct.new(:cop_name, :offenses) do
+          def file_groups
+            @_file_groups ||= offenses.group_by(&:file_path).map do |file, offenses|
+              FileGroup.new(file, offenses.length)
+            end
+          end
+
+          def print(output)
+            output.puts("#{cop_name}:")
+            output.puts("  Exclude:")
+            file_groups.sort_by(&:file).each do |file_group|
+              file_group.print(output)
+            end
+            output.puts
+          end
+        end
+
+        def initialize(offense_list)
+          @offense_list = offense_list
+        end
+
+        def call(output)
+          offense_groups.sort_by(&:cop_name).each { |group| group.print(output) }
+        end
+
+        private
+
+        def offense_groups
+          @_offense_groups ||= offense_list.group_by(&:cop_name)
+            .map { |cop_name, offenses| OffenseGroup.new(cop_name, offenses) }
+        end
+      end
+    end
+  end
+end

data/lib/datarockets_style/version.rb

@@ -0,0 +1,3 @@
+module DatarocketsStyle
+  VERSION = "1.2.0".freeze
+end

data/manual/cops_layout.md

@@ -52,6 +52,30 @@ Name | Default value | Configurable values
 EnforcedStyle | `with_first_parameter` | `with_first_parameter`, `with_fixed_indentation`
 IndentationWidth | `<none>` | Integer
 
+# RSpec
+
+## RSpec/PreferBeforeOverSetup
+
+Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+--- | --- | --- | --- | ---
+Enabled | Yes | Yes | 1.2.0 | -
+
+Checks that tests use `before` instead of RoR unit-test `setup` method (part of `rspec-rails` gem)
+
+### Example
+
+```ruby
+# bad
+setup do
+  allow(post).to receive(:publish!)
+end
+
+# good
+before do
+  allow(post).to receive(:publish!)
+end
+```
+
 # Style
 
 ## Style/NestedInterpolation

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datarockets-style
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Roman Dubrovsky
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-05-26 00:00:00.000000000 Z
+date: 2021-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -16,43 +16,85 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.84'
+        version: '1.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.84'
+        version: '1.10'
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.2
+        version: '2.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.2
+        version: '2.9'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.39'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.39'
-description: 
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+description:
 email:
 - r.dubrovsky@datarockets.com
 executables: []
@@ -70,7 +112,6 @@ files:
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - Makefile
 - README.md
@@ -86,19 +127,20 @@ files:
 - doc/STYLE_GUIDE.md
 - doc/STYLE_GUIDE_RAILS.md
 - 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
+- lib/datarockets_style.rb
+- lib/datarockets_style/cop/layout/array_alignment_extended.rb
+- lib/datarockets_style/cop/rspec/prefer_before_over_setup.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
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -113,9 +155,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Datarockets style guides and shared style configs
 test_files: []