rubocop-rails 2.4.1

data/lib/rubocop/cop/rails/unknown_env.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # This cop checks that environments called with `Rails.env` predicates
+      # exist.
+      #
+      # @example
+      #   # bad
+      #   Rails.env.proudction?
+      #   Rails.env == 'proudction'
+      #
+      #   # good
+      #   Rails.env.production?
+      #   Rails.env == 'production'
+      class UnknownEnv < Cop
+        include NameSimilarity
+
+        MSG = 'Unknown environment `%<name>s`.'
+        MSG_SIMILAR = 'Unknown environment `%<name>s`. ' \
+                      'Did you mean `%<similar>s`?'
+
+        def_node_matcher :rails_env?, <<~PATTERN
+          (send
+            {(const nil? :Rails) (const (cbase) :Rails)}
+            :env)
+        PATTERN
+
+        def_node_matcher :unknown_environment_predicate?, <<~PATTERN
+          (send #rails_env? $#unknown_env_predicate?)
+        PATTERN
+
+        def_node_matcher :unknown_environment_equal?, <<~PATTERN
+          {
+            (send #rails_env? {:== :===} $(str #unknown_env_name?))
+            (send $(str #unknown_env_name?) {:== :===} #rails_env?)
+          }
+        PATTERN
+
+        def on_send(node)
+          unknown_environment_predicate?(node) do |name|
+            add_offense(node, location: :selector, message: message(name))
+          end
+
+          unknown_environment_equal?(node) do |str_node|
+            name = str_node.value
+            add_offense(str_node, message: message(name))
+          end
+        end
+
+        private
+
+        def collect_variable_like_names(_scope)
+          environments
+        end
+
+        def message(name)
+          name = name.to_s.chomp('?')
+          similar = find_similar_name(name, [])
+          if similar
+            format(MSG_SIMILAR, name: name, similar: similar)
+          else
+            format(MSG, name: name)
+          end
+        end
+
+        def unknown_env_predicate?(name)
+          name = name.to_s
+          name.end_with?('?') &&
+            !environments.include?(name[0..-2])
+        end
+
+        def unknown_env_name?(name)
+          !environments.include?(name)
+        end
+
+        def environments
+          cop_config['Environments']
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rails/validation.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # This cop checks for the use of old-style attribute validation macros.
+      #
+      # @example
+      #   # bad
+      #   validates_acceptance_of :foo
+      #   validates_confirmation_of :foo
+      #   validates_exclusion_of :foo
+      #   validates_format_of :foo
+      #   validates_inclusion_of :foo
+      #   validates_length_of :foo
+      #   validates_numericality_of :foo
+      #   validates_presence_of :foo
+      #   validates_absence_of :foo
+      #   validates_size_of :foo
+      #   validates_uniqueness_of :foo
+      #
+      #   # good
+      #   validates :foo, acceptance: true
+      #   validates :foo, confirmation: true
+      #   validates :foo, exclusion: true
+      #   validates :foo, format: true
+      #   validates :foo, inclusion: true
+      #   validates :foo, length: true
+      #   validates :foo, numericality: true
+      #   validates :foo, presence: true
+      #   validates :foo, absence: true
+      #   validates :foo, size: true
+      #   validates :foo, uniqueness: true
+      #
+      class Validation < Cop
+        MSG = 'Prefer the new style validations `%<prefer>s` over ' \
+              '`%<current>s`.'
+
+        TYPES = %w[
+          acceptance
+          confirmation
+          exclusion
+          format
+          inclusion
+          length
+          numericality
+          presence
+          absence
+          size
+          uniqueness
+        ].freeze
+
+        DENYLIST = TYPES.map { |p| "validates_#{p}_of".to_sym }.freeze
+        ALLOWLIST = TYPES.map { |p| "validates :column, #{p}: value" }.freeze
+
+        def on_send(node)
+          return unless !node.receiver && DENYLIST.include?(node.method_name)
+
+          add_offense(node, location: :selector)
+        end
+
+        def autocorrect(node)
+          last_argument = node.arguments.last
+          return if !last_argument.literal? && !last_argument.splat_type? &&
+                    !frozen_array_argument?(last_argument)
+
+          lambda do |corrector|
+            corrector.replace(node.loc.selector, 'validates')
+            correct_validate_type(corrector, node)
+          end
+        end
+
+        private
+
+        def message(node)
+          format(MSG, prefer: preferred_method(node.method_name),
+                      current: node.method_name)
+        end
+
+        def preferred_method(method)
+          ALLOWLIST[DENYLIST.index(method.to_sym)]
+        end
+
+        def correct_validate_type(corrector, node)
+          last_argument = node.last_argument
+
+          if last_argument.hash_type?
+            correct_validate_type_for_hash(corrector, node, last_argument)
+          elsif last_argument.array_type?
+            loc = last_argument.loc
+
+            correct_validate_type_for_array(corrector, node, last_argument, loc)
+          elsif frozen_array_argument?(last_argument)
+            arguments = node.last_argument.receiver
+            loc = arguments.parent.loc
+
+            correct_validate_type_for_array(corrector, node, arguments, loc)
+          else
+            range = last_argument.source_range
+
+            corrector.insert_after(range, ", #{validate_type(node)}: true")
+          end
+        end
+
+        def correct_validate_type_for_hash(corrector, node, arguments)
+          corrector.replace(
+            arguments.loc.expression,
+            "#{validate_type(node)}: #{braced_options(arguments)}"
+          )
+        end
+
+        def correct_validate_type_for_array(corrector, node, arguments, loc)
+          attributes = []
+
+          arguments.each_child_node do |child_node|
+            attributes << if arguments.percent_literal?
+                            ":#{child_node.source}"
+                          else
+                            child_node.source
+                          end
+          end
+
+          corrector.replace(
+            loc.expression,
+            "#{attributes.join(', ')}, #{validate_type(node)}: true"
+          )
+        end
+
+        def validate_type(node)
+          node.method_name.to_s.split('_')[1]
+        end
+
+        def frozen_array_argument?(argument)
+          argument.send_type? && argument.method?(:freeze)
+        end
+
+        def braced_options(options)
+          if options.braces?
+            options.source
+          else
+            "{ #{options.source} }"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rails_cops.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require_relative 'mixin/target_rails_version'
+
+require_relative 'rails/action_filter'
+require_relative 'rails/active_record_aliases'
+require_relative 'rails/active_record_override'
+require_relative 'rails/active_support_aliases'
+require_relative 'rails/application_controller'
+require_relative 'rails/application_job'
+require_relative 'rails/application_mailer'
+require_relative 'rails/application_record'
+require_relative 'rails/assert_not'
+require_relative 'rails/belongs_to'
+require_relative 'rails/blank'
+require_relative 'rails/bulk_change_table'
+require_relative 'rails/create_table_with_timestamps'
+require_relative 'rails/date'
+require_relative 'rails/delegate'
+require_relative 'rails/delegate_allow_blank'
+require_relative 'rails/dynamic_find_by'
+require_relative 'rails/enum_hash'
+require_relative 'rails/enum_uniqueness'
+require_relative 'rails/environment_comparison'
+require_relative 'rails/exit'
+require_relative 'rails/file_path'
+require_relative 'rails/find_by'
+require_relative 'rails/find_each'
+require_relative 'rails/has_and_belongs_to_many'
+require_relative 'rails/has_many_or_has_one_dependent'
+require_relative 'rails/helper_instance_variable'
+require_relative 'rails/http_positional_arguments'
+require_relative 'rails/http_status'
+require_relative 'rails/ignored_skip_action_filter_option'
+require_relative 'rails/inverse_of'
+require_relative 'rails/lexically_scoped_action_filter'
+require_relative 'rails/link_to_blank'
+require_relative 'rails/not_null_column'
+require_relative 'rails/output'
+require_relative 'rails/output_safety'
+require_relative 'rails/pluralization_grammar'
+require_relative 'rails/presence'
+require_relative 'rails/present'
+require_relative 'rails/rake_environment'
+require_relative 'rails/read_write_attribute'
+require_relative 'rails/redundant_allow_nil'
+require_relative 'rails/redundant_receiver_in_with_options'
+require_relative 'rails/reflection_class_name'
+require_relative 'rails/refute_methods'
+require_relative 'rails/relative_date_constant'
+require_relative 'rails/request_referer'
+require_relative 'rails/reversible_migration'
+require_relative 'rails/safe_navigation'
+require_relative 'rails/safe_navigation_with_blank'
+require_relative 'rails/save_bang'
+require_relative 'rails/scope_args'
+require_relative 'rails/skips_model_validations'
+require_relative 'rails/time_zone'
+require_relative 'rails/uniq_before_pluck'
+require_relative 'rails/unknown_env'
+require_relative 'rails/validation'

data/lib/rubocop/rails.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module RuboCop
+  # RuboCop Rails project namespace
+  module Rails
+    PROJECT_ROOT   = Pathname.new(__dir__).parent.parent.expand_path.freeze
+    CONFIG_DEFAULT = PROJECT_ROOT.join('config', 'default.yml').freeze
+    CONFIG         = YAML.safe_load(CONFIG_DEFAULT.read).freeze
+
+    private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
+  end
+end

data/lib/rubocop/rails/inject.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Rails
+    # Because RuboCop doesn't yet support plugins, we have to monkey patch in a
+    # bit of our configuration.
+    module Inject
+      def self.defaults!
+        path = CONFIG_DEFAULT.to_s
+        hash = ConfigLoader.send(:load_yaml_configuration, path)
+        config = Config.new(hash, path)
+        puts "configuration from #{path}" if ConfigLoader.debug?
+        config = ConfigLoader.merge_with_default(config, path, unset_nil: false)
+        ConfigLoader.instance_variable_set(:@default_configuration, config)
+      end
+    end
+  end
+end

data/lib/rubocop/rails/version.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Rails
+    # This module holds the RuboCop Rails version information.
+    module Version
+      STRING = '2.4.1'
+    end
+  end
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-rails
+version: !ruby/object:Gem::Version
+  version: 2.4.1
+platform: ruby
+authors:
+- Bozhidar Batsov
+- Jonas Arvidsson
+- Yuji Nakayama
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.72.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.72.0
+description: |
+  Automatic Rails code style checking tool.
+  A RuboCop extension focused on enforcing Rails best practices and coding conventions.
+email: rubocop@googlegroups.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- LICENSE.txt
+- README.md
+- bin/setup
+- config/default.yml
+- lib/rubocop-rails.rb
+- lib/rubocop/cop/mixin/target_rails_version.rb
+- lib/rubocop/cop/rails/action_filter.rb
+- lib/rubocop/cop/rails/active_record_aliases.rb
+- lib/rubocop/cop/rails/active_record_override.rb
+- lib/rubocop/cop/rails/active_support_aliases.rb
+- lib/rubocop/cop/rails/application_controller.rb
+- lib/rubocop/cop/rails/application_job.rb
+- lib/rubocop/cop/rails/application_mailer.rb
+- lib/rubocop/cop/rails/application_record.rb
+- lib/rubocop/cop/rails/assert_not.rb
+- lib/rubocop/cop/rails/belongs_to.rb
+- lib/rubocop/cop/rails/blank.rb
+- lib/rubocop/cop/rails/bulk_change_table.rb
+- lib/rubocop/cop/rails/create_table_with_timestamps.rb
+- lib/rubocop/cop/rails/date.rb
+- lib/rubocop/cop/rails/delegate.rb
+- lib/rubocop/cop/rails/delegate_allow_blank.rb
+- lib/rubocop/cop/rails/dynamic_find_by.rb
+- lib/rubocop/cop/rails/enum_hash.rb
+- lib/rubocop/cop/rails/enum_uniqueness.rb
+- lib/rubocop/cop/rails/environment_comparison.rb
+- lib/rubocop/cop/rails/exit.rb
+- lib/rubocop/cop/rails/file_path.rb
+- lib/rubocop/cop/rails/find_by.rb
+- lib/rubocop/cop/rails/find_each.rb
+- lib/rubocop/cop/rails/has_and_belongs_to_many.rb
+- lib/rubocop/cop/rails/has_many_or_has_one_dependent.rb
+- lib/rubocop/cop/rails/helper_instance_variable.rb
+- lib/rubocop/cop/rails/http_positional_arguments.rb
+- lib/rubocop/cop/rails/http_status.rb
+- lib/rubocop/cop/rails/ignored_skip_action_filter_option.rb
+- lib/rubocop/cop/rails/inverse_of.rb
+- lib/rubocop/cop/rails/lexically_scoped_action_filter.rb
+- lib/rubocop/cop/rails/link_to_blank.rb
+- lib/rubocop/cop/rails/not_null_column.rb
+- lib/rubocop/cop/rails/output.rb
+- lib/rubocop/cop/rails/output_safety.rb
+- lib/rubocop/cop/rails/pluralization_grammar.rb
+- lib/rubocop/cop/rails/presence.rb
+- lib/rubocop/cop/rails/present.rb
+- lib/rubocop/cop/rails/rake_environment.rb
+- lib/rubocop/cop/rails/read_write_attribute.rb
+- lib/rubocop/cop/rails/redundant_allow_nil.rb
+- lib/rubocop/cop/rails/redundant_receiver_in_with_options.rb
+- lib/rubocop/cop/rails/reflection_class_name.rb
+- lib/rubocop/cop/rails/refute_methods.rb
+- lib/rubocop/cop/rails/relative_date_constant.rb
+- lib/rubocop/cop/rails/request_referer.rb
+- lib/rubocop/cop/rails/reversible_migration.rb
+- lib/rubocop/cop/rails/safe_navigation.rb
+- lib/rubocop/cop/rails/safe_navigation_with_blank.rb
+- lib/rubocop/cop/rails/save_bang.rb
+- lib/rubocop/cop/rails/scope_args.rb
+- lib/rubocop/cop/rails/skips_model_validations.rb
+- lib/rubocop/cop/rails/time_zone.rb
+- lib/rubocop/cop/rails/uniq_before_pluck.rb
+- lib/rubocop/cop/rails/unknown_env.rb
+- lib/rubocop/cop/rails/validation.rb
+- lib/rubocop/cop/rails_cops.rb
+- lib/rubocop/rails.rb
+- lib/rubocop/rails/inject.rb
+- lib/rubocop/rails/version.rb
+homepage: https://github.com/rubocop-hq/rubocop-rails
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://docs.rubocop.org/projects/rails
+  changelog_uri: https://github.com/rubocop-hq/rubocop-rails/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/rubocop-hq/rubocop-rails/
+  documentation_uri: https://docs.rubocop.org/projects/rails
+  bug_tracker_uri: https://github.com/rubocop-hq/rubocop-rails/issues
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Automatic Rails code style checking tool.
+test_files: []