Sha256: 0e6eb20c893436aab14c8a12b9f215c0c105bac0c75ae1a4b44e440138ff2e8a

Contents?: true

Size: 1.5 KB

Versions: 53

Compression:

Stored size: 1.5 KB

Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    module Rails
      # Favor `Rails.public_path` over `Rails.root` with `'public'`
      #
      # @example
      #   # bad
      #   Rails.root.join('public')
      #   Rails.root.join('public/file.pdf')
      #   Rails.root.join('public', 'file.pdf')
      #
      #   # good
      #   Rails.public_path
      #   Rails.public_path.join('file.pdf')
      #   Rails.public_path.join('file.pdf')
      #
      class RootPublicPath < Base
        extend AutoCorrector

        MSG = 'Use `Rails.public_path`.'

        RESTRICT_ON_SEND = %i[join].to_set.freeze

        PATTERN = %r{\Apublic(/|\z)}.freeze

        def_node_matcher :rails_root_public, <<~PATTERN
          (send
            (send
              $(const {nil? cbase} :Rails) :root) :join
            (str $#public_path?) $...)
        PATTERN

        def on_send(node)
          return unless (rails, maybe_public_path, other_args = rails_root_public(node))

          add_offense(node) do |corrector|
            first_args = maybe_public_path.gsub(PATTERN, '')

            args = other_args.map(&:source)
            args.unshift("'#{first_args}'") unless first_args.empty?

            replacement = "#{rails.source}.public_path"
            replacement += ".join(#{args.join(', ')})" unless args.empty?

            corrector.replace(node, replacement)
          end
        end

        private

        def public_path?(string)
          PATTERN.match?(string)
        end
      end
    end
  end
end

Version data entries

53 entries across 50 versions & 8 rubygems

Version Path
rubocop-rails-2.30.3 lib/rubocop/cop/rails/root_public_path.rb
rubocop-rails-2.30.2 lib/rubocop/cop/rails/root_public_path.rb
rubocop-rails-2.30.1 lib/rubocop/cop/rails/root_public_path.rb
rubocop-rails-2.30.0 lib/rubocop/cop/rails/root_public_path.rb
tailscale_middleware-0.0.3 vendor/cache/ruby/3.4.0/gems/rubocop-rails-2.29.1/lib/rubocop/cop/rails/root_public_path.rb
rubocop-rails-2.29.1 lib/rubocop/cop/rails/root_public_path.rb
rubocop-rails-2.29.0 lib/rubocop/cop/rails/root_public_path.rb
rubocop-rails-2.28.0 lib/rubocop/cop/rails/root_public_path.rb
rubocop-rails-2.27.0 lib/rubocop/cop/rails/root_public_path.rb
rubocop-rails-2.26.2 lib/rubocop/cop/rails/root_public_path.rb
rubocop-rails-2.26.1 lib/rubocop/cop/rails/root_public_path.rb
rubocop-rails-2.26.0 lib/rubocop/cop/rails/root_public_path.rb
blacklight-spotlight-3.6.0.beta8 vendor/bundle/ruby/3.2.0/gems/rubocop-rails-2.25.1/lib/rubocop/cop/rails/root_public_path.rb
rubocop-rails-2.25.1 lib/rubocop/cop/rails/root_public_path.rb
cm-admin-1.5.22 vendor/bundle/ruby/3.3.0/gems/rubocop-rails-2.15.2/lib/rubocop/cop/rails/root_public_path.rb
cm-admin-1.5.21 vendor/bundle/ruby/3.3.0/gems/rubocop-rails-2.15.2/lib/rubocop/cop/rails/root_public_path.rb
cm-admin-1.5.20 vendor/bundle/ruby/3.3.0/gems/rubocop-rails-2.15.2/lib/rubocop/cop/rails/root_public_path.rb
katalyst-govuk-formbuilder-1.9.2 vendor/bundle/ruby/3.3.0/gems/rubocop-rails-2.25.0/lib/rubocop/cop/rails/root_public_path.rb
rubocop-rails-2.24.1 lib/rubocop/cop/rails/root_public_path.rb
rubocop-rails-2.24.0 lib/rubocop/cop/rails/root_public_path.rb