datarockets-style 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13302183c2bb2361f4069f312d84b44569bdac9bd3e012868cf6845357d1754f
-  data.tar.gz: 6d8c66f18353e28136e855a7cf3a0ee1933c4103f68fc1cb0a602d8dcaa5190a
+  metadata.gz: 7ef40260e95ced035f4c8f86b18c807997a4e79228c72e75a880477fecb8030e
+  data.tar.gz: b35d77e092533855df4092585e8af229653859c6cce685bed399f50880d5bc49
 SHA512:
-  metadata.gz: c17ff90118be39c8b0b078aea534e4a650e4c5dcb3dbccbda0cca6394c7372a97530b50112e76691155237b9944efd26d54fab5f7ef3437d20470c535f1f720b
-  data.tar.gz: 4ddba3d32c03980657729a5b46d7d186fe589ddff67a4d4743bf377180c58bd3d2e0de59451286b28accfa12384852c96a59cf1a150efe611a9d9d361e3cc870
+  metadata.gz: a8b0a2bcb81d48837a708f337e3f37baba4e26d86f1be42fa02c12f441e18286b1164996a0a0026f870886a887c7664300683de2b80dee0e7fc6c4721934fce2
+  data.tar.gz: 0dd7f1c7bd2a72a7cbebe4fb5eaf4b399f53d014b0ecfe701be979917e09e7bc7467367d0dced76d25f9a76ad369b88da746285774e092b0078eea180209c913

data/.gitignore

@@ -6,3 +6,4 @@
 /tmp/
 
 .byebug_history
+.idea

data/CHANGELOG.md

@@ -4,6 +4,20 @@ The format is described in [Contributing notes](CONTRIBUTING.md#changelog-entry-
 
 ## master
 
+## 1.1.0 (2021-02-09)
+
+### Changed
+
+* Setup `EnforcedStyleForMultiline` for `Style/TrailingCommaInHashLiteral` rule. ([@r.dubrovsky][])
+* Update rubocop to ```1.9.1```.([@paydaylight][])
+* Update rubocop-rails requirement to ```>= 2.8.0, < 2.10.0```. ([@paydaylight][])
+* Update rubocop-rspec to `2.2.0`. ([@paydaylight][])
+* Change ```Datarockets::Style``` module to ```DatarocketsStyle```. ([@paydaylight][])
+
+### Fixed
+
+* [#177](https://github.com/datarockets/datarockets-style/issues/177) set ```Layout/MultilineOperationIndentation``` to indented ([@paydaylight][])
+
 ## 1.0.0 (2020-11-10)
 
 ### Changed
@@ -207,4 +221,4 @@ The format is described in [Contributing notes](CONTRIBUTING.md#changelog-entry-
 [@v.kuzmik]: https://github.com/TheBlackArroVV/
 [@a.branzeanu]: https://github.com/texpert
 [@nikitasakov]: https://github.com/nikitasakov
-
+[@paydaylight]: https://github.com/paydaylight

data/Gemfile.lock

@@ -1,31 +1,31 @@
 PATH
   remote: .
   specs:
-    datarockets-style (1.0.0)
+    datarockets-style (1.1.0)
       rubocop (>= 1.2, < 2.0)
-      rubocop-rails (>= 2.8.0, < 2.9.0)
+      rubocop-rails (>= 2.8.0, < 2.10.0)
       rubocop-rspec (~> 2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.3.4)
+    activesupport (6.1.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
-    ast (2.4.1)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
     byebug (11.1.3)
     coderay (1.1.2)
     concurrent-ruby (1.1.7)
     diff-lcs (1.4.4)
-    i18n (1.8.5)
+    i18n (1.8.7)
       concurrent-ruby (~> 1.0)
     method_source (1.0.0)
-    minitest (5.14.2)
-    parallel (1.20.0)
-    parser (2.7.2.0)
+    minitest (5.14.3)
+    parallel (1.20.1)
+    parser (3.0.0.0)
       ast (~> 2.4.1)
     pry (0.13.1)
       coderay (~> 1.1)
@@ -35,8 +35,8 @@ GEM
       pry (~> 0.13.0)
     rack (2.2.3)
     rainbow (3.0.0)
-    rake (13.0.1)
-    regexp_parser (1.8.2)
+    rake (13.0.3)
+    regexp_parser (2.0.3)
     rexml (3.2.4)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
@@ -51,30 +51,29 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.0)
-    rubocop (1.2.0)
+    rubocop (1.9.1)
       parallel (~> 1.10)
-      parser (>= 2.7.1.5)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8)
+      regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.0.1)
+      rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.1.1)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
       parser (>= 2.7.1.5)
-    rubocop-rails (2.8.1)
+    rubocop-rails (2.9.1)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
-      rubocop (>= 0.87.0)
-    rubocop-rspec (2.0.0)
+      rubocop (>= 0.90.0, < 2.0)
+    rubocop-rspec (2.1.0)
       rubocop (~> 1.0)
       rubocop-ast (>= 1.1.0)
-    ruby-progressbar (1.10.1)
-    thread_safe (0.3.6)
-    tzinfo (1.2.8)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.7.0)
-    zeitwerk (2.4.1)
+    ruby-progressbar (1.11.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.0.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
-require "datarockets/style"
+require "datarockets_style"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/config/base.yml

@@ -1,4 +1,4 @@
-require: datarockets/style
+require: datarockets_style
 
 AllCops:
   NewCops: enable
@@ -50,6 +50,9 @@ Layout/FirstHashElementIndentation:
 Layout/MultilineMethodCallIndentation:
   EnforcedStyle: indented
 
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
 Layout/SpaceAroundMethodCallOperator:
   Enabled: true
 
@@ -186,3 +189,6 @@ Style/StringConcatenation:
 
 Style/StringLiterals:
   EnforcedStyle: double_quotes
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma

data/datarockets-style.gemspec

@@ -1,10 +1,10 @@
 lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "datarockets/style/version"
+require "datarockets_style/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "datarockets-style"
-  spec.version       = Datarockets::Style::VERSION
+  spec.version       = DatarocketsStyle::VERSION
   spec.authors       = ["Roman Dubrovsky"]
   spec.email         = ["r.dubrovsky@datarockets.com"]
 
@@ -31,6 +31,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "rubocop", ">= 1.2  ", "< 2.0"
-  spec.add_dependency "rubocop-rails", ">= 2.8.0", "< 2.9.0"
+  spec.add_dependency "rubocop-rails", ">= 2.8.0", "< 2.10.0"
   spec.add_dependency "rubocop-rspec", "~> 2.0"
 end

data/doc/STYLE_GUIDE.md

@@ -392,6 +392,46 @@ def foo
 end
 ```
 
+* <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/lib/datarockets_style.rb

@@ -0,0 +1,12 @@
+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"
+
+# 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/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

@@ -46,6 +46,6 @@ class TodoListFormatter < RuboCop::Formatter::ProgressFormatter
       @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.1.0".freeze
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datarockets-style
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Roman Dubrovsky
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-09 00:00:00.000000000 Z
+date: 2021-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -39,7 +39,7 @@ dependencies:
         version: 2.8.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 2.9.0
+        version: 2.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -49,7 +49,7 @@ dependencies:
         version: 2.8.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 2.9.0
+        version: 2.10.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -98,12 +98,12 @@ 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/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:
@@ -125,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.5
 signing_key: 
 specification_version: 4
 summary: Datarockets style guides and shared style configs

data/lib/datarockets/style.rb

@@ -1,14 +0,0 @@
-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"
-
-module Datarockets
-  # Datarickors sharable config
-  module Style
-    # Your code goes here...
-  end
-end

data/lib/datarockets/style/cop/layout/array_alignment_extended.rb

@@ -1,83 +0,0 @@
-# frozen_string_literal: true
-
-module Datarockets
-  module Style
-    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
-end

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

@@ -1,37 +0,0 @@
-module Datarockets
-  module Style
-    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
-end

data/lib/datarockets/style/formatter/todo_list_formatter/report_summary.rb

@@ -1,57 +0,0 @@
-module Datarockets
-  module Style
-    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
-end

data/lib/datarockets/style/version.rb

@@ -1,5 +0,0 @@
-module Datarockets
-  module Style
-    VERSION = "1.0.0".freeze
-  end
-end