spbtv_code_style 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57082afb7d19156a7145046e3989e8e73189751c
-  data.tar.gz: defc7bcedc0a0d240e8cb8d700e801c167b2088f
+  metadata.gz: 0de24f59699801bfff09af903c583958f4b3c755
+  data.tar.gz: 197af631ec792872175430b8c7ccfe1dfacdb1a2
 SHA512:
-  metadata.gz: 8156435a9f0fe302f9be4315edc4282af427b4553b78eaa5ef6cfe7cb5c9ff6b0e74477df5787f671b1b22a5f56f04d6fd5212fc250b9376f0709d8ce1e6ae74
-  data.tar.gz: 75c97c92314ead99f81655fc8490ee4528e81714ba1660d6863412babf4ce272bfc3c441de76b2df6bb5467b3f00823b6a5f6b721d9541b050292ab71d7a6387
+  metadata.gz: 0abe4066eb2bb1c5ef46f06f721d97d2d0f3b771533e5feb483f6d00a9fea89c16b3dd1c28d6c2da4d6ef573df3e0f21161a72d69f4f3a566fc4b0edf765b5b7
+  data.tar.gz: 259dfdec5f01c3632aef02bec2f6445dbcd2120c310e2ec59177107a0d33e72b212a29bd95a7ac2eedb6c222416a0c3637ea62b5ca3222717e026a8b2394132e

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -1,3 +1,11 @@
+require:
+  - rubocop-rspec
+  - ./lib/rubocop/cop/spbtv/postgres/add_column_with_default
+  - ./lib/rubocop/cop/spbtv/postgres/add_column_with_not_null
+  - ./lib/rubocop/cop/spbtv/postgres/add_index
+  - ./lib/rubocop/cop/spbtv/postgres/change_column
+  - ./lib/rubocop/cop/spbtv/multiple_validation
+
 Rails:
  Enabled: true
 
@@ -29,9 +37,6 @@ Style/Next:
 Style/GuardClause:
   Enabled: false
 
-Metrics/LineLength:
-  Max: 120
-
 Style/TrivialAccessors:
   AllowPredicates: true
 
@@ -41,6 +46,11 @@ Style/IfUnlessModifier:
 Style/EmptyCaseCondition:
   Enabled: false
 
+Metrics/ClassLength:
+  Severity: refactor
+  Exclude:
+    - '**/db/**/*'
+
 Metrics/AbcSize:
   Severity: refactor
 
@@ -50,8 +60,18 @@ Metrics/PerceivedComplexity:
 Metrics/ParameterLists:
   Severity: refactor
 
+Metrics/LineLength:
+  Max: 120
+
+Metrics/AbcSize:
+  Severity: refactor
+  Exclude:
+    - '**/db/**/*'
+
 Metrics/MethodLength:
   Severity: refactor
+  Exclude:
+    - '**/db/**/*'
 
 Metrics/CyclomaticComplexity:
   Severity: refactor
@@ -76,3 +96,33 @@ Style/TrailingCommaInLiteral:
 
 Style/TrailingCommaInArguments:
   EnforcedStyleForMultiline: comma
+
+Postgres/AddColumnWithDefault:
+  Exclude:
+    - '**/db/migrate/2015*'
+    - '**/db/migrate/20160*'
+    - '**/db/migrate/201610*'
+
+Postgres/AddColumnWithNotNull:
+  Exclude:
+    - '**/db/migrate/2015*'
+    - '**/db/migrate/20160*'
+    - '**/db/migrate/201610*'
+
+Postgres/AddIndex:
+  Exclude:
+    - '**/db/migrate/2015*'
+    - '**/db/migrate/20160*'
+    - '**/db/migrate/201610*'
+
+Postgres/ChangeColumn:
+  Exclude:
+    - '**/db/migrate/2015*'
+    - '**/db/migrate/20160*'
+    - '**/db/migrate/201610*'
+
+Rails/NotNullColumn:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Max: 3

data/.strict_rubocop.yml

@@ -3,6 +3,8 @@ inherit_from:
 
 Metrics/AbcSize:
   Severity: warning
+  Exclude:
+    - '**/db/**/*'
 
 Metrics/PerceivedComplexity:
   Severity: warning
@@ -12,6 +14,8 @@ Metrics/ParameterLists:
 
 Metrics/MethodLength:
   Severity: warning
+  Exclude:
+    - '**/db/**/*'
 
 Metrics/CyclomaticComplexity:
   Severity: warning

data/.travis.yml

@@ -1,7 +1,6 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.1.5
   - 2.2.2
   - 2.2.3
   - ruby-head
@@ -12,3 +11,4 @@ matrix:
 before_install: gem install bundler -v 1.10.6
 script:
   - bundle exec rubocop --fail-level C
+  - bundle exec rspec

data/lib/rubocop/cop/spbtv/multiple_validation.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Spbtv
+      # Prefer validating one attribute at once.
+      #
+      # @example
+      #   @bad
+      #   validates :name, :age, presence: true
+      #
+      #   @good
+      #   validates :age, presence: true
+      #   validates :name, presence: true
+      #
+      class MultipleValidation < Cop
+        MSG = 'Prefer validating one attribute at once.'.freeze
+
+        def on_send(node)
+          _, _, *args = *node
+          if node.command?(:validates) && args.length > 2
+            add_offense(node, :selector, MSG)
+          end
+        end
+
+        private
+
+        def autocorrect(node)
+          _receiver, method_name, *args = *node
+          *attributes, options = args
+
+          multiline_replacement = attributes.map do |attribute|
+            "#{method_name} #{attribute.source}, #{options.source}"
+          end
+
+          lambda do |corrector|
+            corrector.replace(node.source_range, multiline_replacement.sort.join("\n"))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/spbtv/postgres/add_column_with_default.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Spbtv
+      module Postgres
+        # Do not add a column with a default value.
+        #
+        # Adding a column with a default requires updating each row of the table (to store
+        # the new column value). For big table this will create long running operation
+        # that locks it.
+        #
+        # So if you intend to fill the column with mostly non default values,
+        # it’s best to add the column with no default, insert the correct values
+        # using UPDATE (correct way is to do batched updates, for example,
+        # update 1000 rows at a time, because big update will create table-wide lock),
+        # and then add any desired default.
+        #
+        # @example
+        #   @bad
+        #   add_column :users, :name, :string, default: "Peter"
+        #
+        #   @good
+        #   add_column :users, :name, :string
+        #   User.find_in_batches do |batch|
+        #     batch.update_all(name: 'Peter')
+        #   end
+        #
+        class AddColumnWithDefault < Cop
+          MSG = 'Do not add a column with a default value.'.freeze
+
+          def_node_matcher :add_column_with_default?, <<-PATTERN
+            (send nil :add_column _ _ _ (hash $...))
+          PATTERN
+
+          def_node_matcher :has_default?, <<-PATTERN
+            (pair (sym :default) !(:nil))
+          PATTERN
+
+          def on_send(node)
+            pairs = add_column_with_default?(node)
+            return unless pairs
+            has_default = pairs.detect { |pair| has_default?(pair) }
+
+            return unless has_default
+
+            add_offense(has_default, :expression)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/spbtv/postgres/add_column_with_not_null.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Spbtv
+      module Postgres
+        # Do not add a NOT NULL column.
+        #
+        # This will have the same problem, as “Add a column with a default”.
+        # To make this operation without locking, you can create a new table
+        # with the addition of the non-nullable column, write to both tables,
+        # backfill, and then switch to the new table. This workaround is
+        # incredibly onerous and need two times more space than is a table takes.
+        #
+        # @example
+        #   @bad
+        #   add_column :users, :name, :string, null: false
+        #
+        #   @good
+        #   add_column :users, :name, :string
+        #
+        class AddColumnWithNotNull < Cop
+          MSG = 'Do not add a NOT NULL column.'.freeze
+
+          def_node_matcher :add_not_null_column?, <<-PATTERN
+            (send nil :add_column _ _ _ (hash $...))
+          PATTERN
+
+          def_node_matcher :null_false?, <<-PATTERN
+            (pair (sym :null) (false))
+          PATTERN
+
+          def on_send(node)
+            pairs = add_not_null_column?(node)
+            return unless pairs
+
+            null_false = pairs.detect { |pair| null_false?(pair) }
+            return unless null_false
+
+            add_offense(null_false, :expression)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/spbtv/postgres/add_index.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Spbtv
+      module Postgres
+        # Do not add an index.
+        #
+        # Normally PostgreSQL locks the table to be indexed against writes and performs
+        # the entire index build with a single scan of the table. Other transactions
+        # can still read the table, but not to insert, update, or delete rows until
+        # the index build is finished.
+        #
+        # To overcome this issue you may specify the CONCURRENTLY option of CREATE INDEX.
+        # When this option is used, PostgreSQL must perform two scans of the table, and in
+        # addition it must wait for all existing transactions that could potentially
+        # modify or use the index to terminate.
+        #
+        # If a problem arises while scanning the table, such as a uniqueness violation
+        # in a unique index, the CREATE INDEX command will fail but leave behind an
+        # “invalid” index.
+        #
+        # The recommended recovery method in such cases is to drop the index and
+        # try again to perform CREATE INDEX CONCURRENTLY.
+        #
+        # Another difference is that a regular CREATE INDEX command can be performed
+        # within a transaction block, but CREATE INDEX CONCURRENTLY cannot.
+        #
+        # @see https://www.postgresql.org/docs/9.2/static/sql-createindex.html#SQL-CREATEINDEX-CONCURRENTLY
+        # @see https://robots.thoughtbot.com/how-to-create-postgres-indexes-concurrently-in
+        #
+        # @example
+        #   @bad
+        #   class AddIndexToAsksActive < ActiveRecord::Migration
+        #     def change
+        #       add_index :asks, :active
+        #     end
+        #   end
+        #
+        #   @good
+        #   class AddIndexToAsksActive < ActiveRecord::Migration
+        #     disable_ddl_transaction!
+        #     def change
+        #       add_index :asks, :active, algorithm: :concurrently
+        #     end
+        #   end
+        #
+        class AddIndex < Cop
+          MSG = 'Do not add an index.'.freeze
+
+          def_node_search :disable_ddl_transaction?, '(send nil :disable_ddl_transaction!)'
+
+          def_node_matcher :add_index_without_options?, <<-PATTERN
+            (send nil :add_index _ _)
+          PATTERN
+
+          def_node_matcher :add_index_with_options?, <<-PATTERN
+            (send nil :add_index _ _ (hash $...))
+          PATTERN
+
+          def_node_matcher :concurrently?, <<-PATTERN
+            (pair (sym :algorithm) (sym :concurrently))
+          PATTERN
+
+          def on_class(node)
+            @disable_ddl_transaction = disable_ddl_transaction?(node)
+          end
+
+          def on_send(node)
+            if add_index_without_options?(node)
+              add_offense(node, :expression)
+            elsif (options = add_index_with_options?(node))
+              has_concurrently = options.detect { |pair| concurrently?(pair) }
+              unless has_concurrently && @disable_ddl_transaction
+                add_offense(node, :expression)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/spbtv/postgres/change_column.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Spbtv
+      module Postgres
+        # Do not change column.
+        #
+        # It is not strictly unsafe for all changes. Changing the
+        # length of a varchar, for example, does not lock a table.
+        # But if column type change requires a rewrite or not depends
+        # on the datatype, in this case this operation requires updating
+        # each row of the table. As workaround, you can add a new column
+        # with needed type, change the code to write to both columns,
+        # and backfill the new column.
+        #
+        # @example
+        #   @bad
+        #   change_column :suppliers, :name, :string, limit: 80
+        #
+        class ChangeColumn < Cop
+          MSG = 'Do not change column.'.freeze
+
+          def on_send(node)
+            _, _, * = *node
+            if node.command?(:change_column)
+              add_offense(node, :selector, MSG)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/spbtv.rb

@@ -0,0 +1,6 @@
+require 'rubocop'
+require_relative 'cop/spbtv/postgres/add_column_with_default'
+require_relative 'cop/spbtv/postgres/add_column_with_not_null'
+require_relative 'cop/spbtv/postgres/add_index'
+require_relative 'cop/spbtv/postgres/change_column'
+require_relative 'cop/spbtv/multiple_validation'

data/lib/spbtv_code_style.rb

@@ -1,4 +1,4 @@
 # Just namespace for version number
 module SpbtvCodeStyle
-  VERSION = '1.5.0'.freeze
+  VERSION = '1.6.0'.freeze
 end

data/spbtv_code_style.gemspec

@@ -18,7 +18,9 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'rubocop-checkstyle_formatter'
   spec.add_runtime_dependency 'rspec_junit_formatter'
 
-  spec.add_development_dependency 'rubocop', '~> 0.40.0'
   spec.add_development_dependency 'bundler', '~> 1.10'
   spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.5'
+  spec.add_development_dependency 'rubocop', '~> 0.43.0'
+  spec.add_development_dependency 'rubocop-rspec', '1.7.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spbtv_code_style
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Tema Bolshakov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-27 00:00:00.000000000 Z
+date: 2016-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop-checkstyle_formatter
@@ -39,47 +39,75 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.40.0
+        version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.40.0
+        version: '1.10'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.43.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.43.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.7.0
 description: 
 email:
 - abolshakov@spbtv.com
@@ -88,6 +116,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - ".rubocop.yml"
 - ".strict_rubocop.yml"
 - ".travis.yml"
@@ -96,6 +125,12 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- lib/rubocop/cop/spbtv/multiple_validation.rb
+- lib/rubocop/cop/spbtv/postgres/add_column_with_default.rb
+- lib/rubocop/cop/spbtv/postgres/add_column_with_not_null.rb
+- lib/rubocop/cop/spbtv/postgres/add_index.rb
+- lib/rubocop/cop/spbtv/postgres/change_column.rb
+- lib/rubocop/spbtv.rb
 - lib/spbtv_code_style.rb
 - spbtv_code_style.gemspec
 homepage: https://github.com/spbtv/spbtv_code_style