line_break_around_conditional_block_spec.rb 9.98 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
require 'spec_helper'
require 'rubocop'
require 'rubocop/rspec/support'
require_relative '../../../rubocop/cop/line_break_around_conditional_block'

describe RuboCop::Cop::LineBreakAroundConditionalBlock do
  include CopHelper

  subject(:cop) { described_class.new }

  shared_examples 'examples with conditional' do |conditional|
    it "flags violation for #{conditional} without line break before" do
      source = <<~RUBY
          do_something
          #{conditional} condition
            do_something_more
          end
      RUBY
      inspect_source(source)

      expect(cop.offenses.size).to eq(1)
      offense = cop.offenses.first

      expect(offense.line).to eq(2)
      expect(cop.highlights).to eq(["#{conditional} condition\n  do_something_more\nend"])
      expect(offense.message).to eq('Add a line break around conditional blocks')
    end

    it "flags violation for #{conditional} without line break after" do
      source = <<~RUBY
          #{conditional} condition
            do_something
          end
          do_something_more
      RUBY
      inspect_source(source)

      expect(cop.offenses.size).to eq(1)
      offense = cop.offenses.first

      expect(offense.line).to eq(1)
      expect(cop.highlights).to eq(["#{conditional} condition\n  do_something\nend"])
      expect(offense.message).to eq('Add a line break around conditional blocks')
    end

    it "doesn't flag violation for #{conditional} with line break before and after" do
      source = <<~RUBY
          #{conditional} condition
            do_something
          end
      RUBY
      inspect_source(source)

      expect(cop.offenses).to be_empty
    end

    it "doesn't flag violation for #{conditional} preceded by a method definition" do
      source = <<~RUBY
          def a_method
            #{conditional} condition
              do_something
            end
          end
      RUBY
      inspect_source(source)

      expect(cop.offenses).to be_empty
    end

    it "doesn't flag violation for #{conditional} preceded by a class definition" do
      source = <<~RUBY
          class Foo
            #{conditional} condition
              do_something
            end
          end
      RUBY
      inspect_source(source)

      expect(cop.offenses).to be_empty
    end

    it "doesn't flag violation for #{conditional} preceded by a module definition" do
      source = <<~RUBY
          module Foo
            #{conditional} condition
              do_something
            end
          end
      RUBY
      inspect_source(source)

      expect(cop.offenses).to be_empty
    end

    it "doesn't flag violation for #{conditional} preceded by a begin definition" do
      source = <<~RUBY
          begin
            #{conditional} condition
              do_something
            end
          end
      RUBY
      inspect_source(source)

      expect(cop.offenses).to be_empty
    end

    it "doesn't flag violation for #{conditional} preceded by an assign/begin definition" do
      source = <<~RUBY
          @project ||= begin
            #{conditional} condition
              do_something
            end
          end
      RUBY
      inspect_source(source)

      expect(cop.offenses).to be_empty
    end

    it "doesn't flag violation for #{conditional} preceded by a block definition" do
      source = <<~RUBY
          on_block(param_a) do |item|
            #{conditional} condition
              do_something
            end
          end
      RUBY
      inspect_source(source)

      expect(cop.offenses).to be_empty
    end

    it "doesn't flag violation for #{conditional} preceded by a block definition using brackets" do
      source = <<~RUBY
          on_block(param_a) { |item|
            #{conditional} condition
              do_something
            end
          }
      RUBY
      inspect_source(source)

      expect(cop.offenses).to be_empty
    end

    it "doesn't flag violation for #{conditional} preceded by a comment" do
      source = <<~RUBY
          # a short comment
          #{conditional} condition
            do_something
          end
      RUBY
      inspect_source(source)

      expect(cop.offenses).to be_empty
    end

    it "doesn't flag violation for #{conditional} preceded by an assignment" do
      source = <<~RUBY
          foo =
            #{conditional} condition
              do_something
            else
              do_something_more
            end
      RUBY
      inspect_source(source)

      expect(cop.offenses).to be_empty
    end

    it "doesn't flag violation for #{conditional} preceded by a multiline comment" do
      source = <<~RUBY
          =begin
          a multiline comment
          =end
          #{conditional} condition
            do_something
          end
      RUBY
      inspect_source(source)

      expect(cop.offenses).to be_empty
    end

    it "doesn't flag violation for #{conditional} preceded by another conditional" do
      source = <<~RUBY
          #{conditional} condition_a
            #{conditional} condition_b
              do_something
            end
          end
      RUBY
      inspect_source(source)

      expect(cop.offenses).to be_empty
    end

    it "doesn't flag violation for #{conditional} preceded by an else" do
      source = <<~RUBY
           if condition_a
             do_something
           else
             #{conditional} condition_b
               do_something_extra
             end
           end
      RUBY
      inspect_source(source)

      expect(cop.offenses).to be_empty
    end

    it "doesn't flag violation for #{conditional} preceded by an elsif" do
      source = <<~RUBY
           if condition_a
             do_something
           elsif condition_b
             #{conditional} condition_c
               do_something_extra
             end
           end
      RUBY
      inspect_source(source)

      expect(cop.offenses).to be_empty
    end

    it "doesn't flag violation for #{conditional} preceded by an ensure" do
      source = <<~RUBY
           def a_method
           ensure
             #{conditional} condition_c
               do_something_extra
             end
           end
      RUBY
      inspect_source(source)

      expect(cop.offenses).to be_empty
    end

    it "doesn't flag violation for #{conditional} preceded by a when" do
      source = <<~RUBY
           case field
           when value
             #{conditional} condition_c
               do_something_extra
             end
           end
      RUBY
      inspect_source(source)

      expect(cop.offenses).to be_empty
    end

    it "doesn't flag violation for #{conditional} followed by an end" do
      source = <<~RUBY
          class Foo

            #{conditional} condition
              do_something
            end
          end
      RUBY
      inspect_source(source)

      expect(cop.offenses).to be_empty
    end

    it "doesn't flag violation for #{conditional} followed by an else" do
      source = <<~RUBY
          #{conditional} condition_a
            #{conditional} condition_b
              do_something
            end
          else
            do_something_extra
          end
      RUBY
      inspect_source(source)

      expect(cop.offenses).to be_empty
    end

    it "doesn't flag violation for #{conditional} followed by a when" do
      source = <<~RUBY
          case
          when condition_a
            #{conditional} condition_b
              do_something
            end
          when condition_c
            do_something_extra
          end
      RUBY
      inspect_source(source)

      expect(cop.offenses).to be_empty
    end

    it "doesn't flag violation for #{conditional} followed by an elsif" do
      source = <<~RUBY
          if condition_a
            #{conditional} condition_b
              do_something
            end
          elsif condition_c
            do_something_extra
          end
      RUBY
      inspect_source(source)

      expect(cop.offenses).to be_empty
    end

    it "doesn't flag violation for #{conditional} followed by a rescue" do
      source = <<~RUBY
            def a_method
              #{conditional} condition
                do_something
              end
              rescue
                do_something_extra
            end
      RUBY
      inspect_source(source)

      expect(cop.offenses).to be_empty
    end

    it "autocorrects #{conditional} without line break before" do
      source = <<~RUBY
          do_something
          #{conditional} condition
            do_something_more
          end
      RUBY
      autocorrected = autocorrect_source(source)

      expected_source = <<~RUBY
          do_something

          #{conditional} condition
            do_something_more
          end
      RUBY
      expect(autocorrected).to eql(expected_source)
    end

    it "autocorrects #{conditional} without line break after" do
      source = <<~RUBY
          #{conditional} condition
            do_something
          end
          do_something_more
      RUBY
      autocorrected = autocorrect_source(source)

      expected_source = <<~RUBY
          #{conditional} condition
            do_something
          end

          do_something_more
      RUBY
      expect(autocorrected).to eql(expected_source)
    end

    it "autocorrects #{conditional} without line break before and after" do
      source = <<~RUBY
          do_something
          #{conditional} condition
            do_something_more
          end
          do_something_extra
      RUBY
      autocorrected = autocorrect_source(source)

      expected_source = <<~RUBY
          do_something

          #{conditional} condition
            do_something_more
          end

          do_something_extra
      RUBY
      expect(autocorrected).to eql(expected_source)
    end
  end

  %w[if unless].each do |example|
    it_behaves_like 'examples with conditional', example
  end

  it "doesn't flag violation for if with elsif" do
    source = <<~RUBY
          if condition
            do_something
          elsif another_condition
            do_something_more
          end
    RUBY
    inspect_source(source)

    expect(cop.offenses).to be_empty
  end
end