rubocop 0.3.0 → 0.3.1

data/.rubocop.yml

@@ -6,6 +6,7 @@ Encoding:
 
 LineLength:
   Enabled: true
+  Max: 79
 
 Tab:
   Enabled: true
@@ -87,3 +88,15 @@ NestedTernaryOperator:
 
 UnlessElse:
   Enabled: true
+
+AmpersandsPipesVsAndOr:
+  Enabled: true
+
+WhenThen:
+  Enabled: true
+
+IfUnlessModifier:
+  Enabled: true
+
+WhileUntilModifier:
+  Enabled: true

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.1

data/lib/rubocop.rb

@@ -25,6 +25,7 @@ require 'rubocop/cop/ternary_operator'
 require 'rubocop/cop/unless_else'
 require 'rubocop/cop/ampersands_pipes_vs_and_or'
 require 'rubocop/cop/when_then'
+require 'rubocop/cop/favor_modifier'
 
 require 'rubocop/report/report'
 require 'rubocop/report/plain_text'

data/lib/rubocop/cli.rb

@@ -44,11 +44,12 @@ module Rubocop
         end
 
         tokens, sexp, correlations = CLI.rip_source(source)
+        config = $options[:config] || config_from_dotfile(File.dirname(file))
 
         cops.each do |cop_klass|
-          config = $options[:config] || config_from_dotfile(File.dirname(file))
           cop_config = config[cop_klass.name.split('::').last] if config
           if cop_config.nil? || cop_config['Enabled']
+            cop_klass.config = cop_config
             cop = cop_klass.new
             cop.correlations = correlations
             cop.inspect(file, source, tokens, sexp)

data/lib/rubocop/cop/end_of_line.rb

@@ -7,9 +7,7 @@ module Rubocop
 
       def inspect(file, source, tokens, sexp)
         source.each_with_index do |line, index|
-          if line =~ /\r$/
-            add_offence(:convention, index + 1, ERROR_MESSAGE)
-          end
+          add_offence(:convention, index + 1, ERROR_MESSAGE) if line =~ /\r$/
         end
       end
     end

data/lib/rubocop/cop/favor_modifier.rb

@@ -0,0 +1,82 @@
+# encoding: utf-8
+
+module Rubocop
+  module Cop
+    module FavorModifier
+      def check(kind, tokens, sexp)
+        token_positions = tokens.map(&:pos)
+        token_texts = tokens.map(&:text)
+        each(kind, sexp) do |s|
+          # If it contains an else, it can't be written as a modifier.
+          next if s[3] && s[3][0] == :else
+
+          sexp_positions = all_positions(s)
+          ix = token_positions.index(sexp_positions.first)
+          if_ix = token_texts[0..ix].rindex(kind.to_s) # index of if/unless/...
+          ix = token_positions.index(sexp_positions.last)
+          end_ix = ix + token_texts[ix..-1].index('end')
+
+          # If there's a comment anywhere between
+          # if/unless/while/until and end, we don't report. It's
+          # possible that the comment will be less clear if put above
+          # a one liner rather than inside.
+          next if tokens[if_ix...end_ix].map(&:type).include?(:on_comment)
+
+          if token_positions[end_ix].lineno - token_positions[if_ix].lineno > 2
+            next # not a single-line body
+          end
+          # The start ix is the index of the leftmost token on the
+          # line of the if/unless, i.e. the index of if/unless itself,
+          # or of the indentation space.
+          start_ix = if_ix.downto(0).find do |ix|
+            ix == 0 || tokens[ix - 1].text =~ /\n/
+          end
+          # The stop index is the index of the token just before
+          # 'end', not counting whitespace tokens.
+          stop_ix = (end_ix - 1).downto(0).find do |ix|
+            tokens[ix].text !~ /\s/
+          end
+          if length(tokens, start_ix, stop_ix) <= LineLength.max
+            add_offence(:convention, token_positions[if_ix].lineno,
+                        error_message)
+          end
+        end
+      end
+
+      def length(tokens, start_ix, stop_ix)
+        (start_ix..stop_ix).inject(0) do |acc, ix|
+          acc + if ix > start_ix && tokens[ix - 1].text =~ /\n/
+                  0
+                else
+                  tokens[ix].text.length
+                end
+        end
+      end
+    end
+
+    class IfUnlessModifier < Cop
+      include FavorModifier
+
+      def error_message
+        'Favor modifier if/unless usage when you have a single-line body. ' +
+          'Another good alternative is the usage of control flow and/or.'
+      end
+
+      def inspect(file, source, tokens, sexp)
+        [:if, :unless].each { |kind| check(kind, tokens, sexp) }
+      end
+    end
+
+    class WhileUntilModifier < Cop
+      include FavorModifier
+
+      def error_message
+        'Favor modifier while/until usage when you have a single-line body.'
+      end
+
+      def inspect(file, source, tokens, sexp)
+        [:while, :until].each { |kind| check(kind, tokens, sexp) }
+      end
+    end
+  end
+end

data/lib/rubocop/cop/line_length.rb

@@ -4,16 +4,20 @@ module Rubocop
   module Cop
     class LineLength < Cop
       ERROR_MESSAGE = 'Line is too long. [%d/%d]'
-      MAX_LINE_LENGTH = 79
 
       def inspect(file, source, tokens, sexp)
         source.each_with_index do |line, index|
-          if line.length > MAX_LINE_LENGTH
-            message = sprintf(ERROR_MESSAGE, line.length, MAX_LINE_LENGTH)
+          max = LineLength.max
+          if line.length > max
+            message = sprintf(ERROR_MESSAGE, line.length, max)
             add_offence(:convention, index + 1, message)
           end
         end
       end
+
+      def self.max
+        LineLength.config ? LineLength.config['Max'] || 79 : 79
+      end
     end
   end
 end

data/lib/rubocop/cop/tab.rb

@@ -7,9 +7,7 @@ module Rubocop
 
       def inspect(file, source, tokens, sexp)
         source.each_with_index do |line, index|
-          if line =~ /^ *\t/
-            add_offence(:convention, index + 1, ERROR_MESSAGE)
-          end
+          add_offence(:convention, index + 1, ERROR_MESSAGE) if line =~ /^ *\t/
         end
       end
     end

data/rubocop.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "rubocop"
-  s.version = "0.3.0"
+  s.version = "0.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Bozhidar Batsov"]
-  s.date = "2013-02-11"
+  s.date = "2013-02-28"
   s.description = "Automatic Ruby code style checking tool. Aims to enforce the community-driven Ruby Style Guide."
   s.email = "bozhidar@batsov.com"
   s.executables = ["rubocop"]
@@ -45,6 +45,7 @@ Gem::Specification.new do |s|
     "lib/rubocop/cop/empty_lines.rb",
     "lib/rubocop/cop/encoding.rb",
     "lib/rubocop/cop/end_of_line.rb",
+    "lib/rubocop/cop/favor_modifier.rb",
     "lib/rubocop/cop/grammar.rb",
     "lib/rubocop/cop/hash_syntax.rb",
     "lib/rubocop/cop/if_then_else.rb",
@@ -75,6 +76,7 @@ Gem::Specification.new do |s|
     "spec/rubocop/cops/empty_lines_spec.rb",
     "spec/rubocop/cops/encoding_spec.rb",
     "spec/rubocop/cops/end_of_line_spec.rb",
+    "spec/rubocop/cops/favor_modifier_spec.rb",
     "spec/rubocop/cops/grammar_spec.rb",
     "spec/rubocop/cops/hash_syntax_spec.rb",
     "spec/rubocop/cops/if_with_semicolon_spec.rb",

data/spec/rubocop/cli_spec.rb

@@ -137,6 +137,28 @@ module Rubocop
         end
       end
 
+      it 'can use an alternative max line length from a config file' do
+        FileUtils.mkdir 'example_src'
+        File.open('example_src/example1.rb', 'w') { |f| f.puts '#' * 90 }
+        File.open('example_src/.rubocop.yml', 'w') do |f|
+          f.puts('LineLength:',
+                 '  Enabled: true',
+                 '  Max: 100')
+        end
+        begin
+          return_code = cli.run(['example_src/example1.rb'])
+          $stdout.string.should ==
+            ['== example_src/example1.rb ==',
+             'C:  1: Missing encoding comment.',
+             '',
+             '1 files inspected, 1 offences detected',
+             ''].join("\n")
+          return_code.should == 1
+        ensure
+          FileUtils.rm_rf 'example_src'
+        end
+      end
+
       it 'finds no violations when checking the rubocop source code' do
         cli.run
         $stdout.string.should =~ /files inspected, 0 offences detected\n/
@@ -153,6 +175,13 @@ module Rubocop
           File.delete 'example.rb'
         end
       end
+
+      it 'has configuration for all cops in .rubocop.yml' do
+        cop_names = Cop::Cop.all.map do |cop_class|
+          cop_class.name.split('::').last
+        end
+        YAML.load_file('.rubocop.yml').keys.sort.should == cop_names.sort
+      end
     end
   end
 end

data/spec/rubocop/cops/favor_modifier_spec.rb

@@ -0,0 +1,112 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+module Rubocop
+  module Cop
+    describe FavorModifier do
+      let (:if_until) { IfUnlessModifier.new }
+      let (:while_until) { WhileUntilModifier.new }
+
+      it 'registers an offence for multiline if that fits on one line' do
+        # This if statement fits exactly on one line if written as a modifier.
+        inspect_source(if_until, 'file.rb',
+                       ['if a_condition_that_is_just_short_enough',
+                        '  some_long_metod_name(followed_by_args)',
+                        'end'])
+        if_until.offences.map(&:message).should ==
+          ['Favor modifier if/unless usage when you have a single-line body.' +
+           ' Another good alternative is the usage of control flow and/or.']
+      end
+
+      it "accepts multiline if that doesn't fit on one line" do
+        check_too_long(if_until, 'if')
+      end
+
+      it 'accepts multiline if whose body is more than one line' do
+        check_short_multiline(if_until, 'if')
+      end
+
+      it 'registers an offence for multiline unless that fits on one line' do
+        inspect_source(if_until, 'file.rb', ['unless a',
+                                        '  b',
+                                        'end'])
+        if_until.offences.map(&:message).should ==
+          ['Favor modifier if/unless usage when you have a single-line body.' +
+           ' Another good alternative is the usage of control flow and/or.']
+      end
+
+      it 'accepts code with EOL comment since user might want to keep it' do
+        inspect_source(if_until, 'file.rb', ['unless a',
+                                             '  b # A comment',
+                                             'end'])
+        if_until.offences.map(&:message).should == []
+      end
+
+      it 'accepts if-else-end' do
+        inspect_source(if_until, 'file.rb',
+                       ['if args.last.is_a? Hash then args.pop else ' +
+                        'Hash.new end'])
+        if_until.offences.map(&:message).should == []
+      end
+
+      it "accepts multiline unless that doesn't fit on one line" do
+        check_too_long(while_until, 'unless')
+      end
+
+      it 'accepts multiline unless whose body is more than one line' do
+        check_short_multiline(while_until, 'unless')
+      end
+
+      it 'registers an offence for multiline while that fits on one line' do
+        check_really_short(while_until, 'while')
+      end
+
+      it "accepts multiline while that doesn't fit on one line" do
+        check_too_long(while_until, 'while')
+      end
+
+      it 'accepts multiline while whose body is more than one line' do
+        check_short_multiline(while_until, 'while')
+      end
+
+      it 'registers an offence for multiline until that fits on one line' do
+        check_really_short(while_until, 'until')
+      end
+
+      it "accepts multiline until that doesn't fit on one line" do
+        check_too_long(while_until, 'until')
+      end
+
+      it 'accepts multiline until whose body is more than one line' do
+        check_short_multiline(while_until, 'until')
+      end
+
+      def check_really_short(cop, keyword)
+        inspect_source(cop, 'file.rb', ["#{keyword} a",
+                                        '  b',
+                                        'end'])
+        cop.offences.map(&:message).should ==
+          ['Favor modifier while/until usage when you have a single-line ' +
+           'body.']
+      end
+
+      def check_too_long(cop, keyword)
+        inspect_source(cop, 'file.rb',
+                       ["  #{keyword} a_lengthy_condition_that_goes_on_and_on",
+                        '    some_long_metod_name(followed_by_args)',
+                        '  end'])
+        cop.offences.map(&:message).should == []
+      end
+
+      def check_short_multiline(cop, keyword)
+        inspect_source(cop, 'file.rb',
+                       ["#{keyword} ENV['COVERAGE']",
+                        "  require 'simplecov'",
+                        '  SimpleCov.start',
+                        'end'])
+        cop.offences.map(&:message).should == []
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-11 00:00:00.000000000 Z
+date: 2013-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -144,6 +144,7 @@ files:
 - lib/rubocop/cop/empty_lines.rb
 - lib/rubocop/cop/encoding.rb
 - lib/rubocop/cop/end_of_line.rb
+- lib/rubocop/cop/favor_modifier.rb
 - lib/rubocop/cop/grammar.rb
 - lib/rubocop/cop/hash_syntax.rb
 - lib/rubocop/cop/if_then_else.rb
@@ -174,6 +175,7 @@ files:
 - spec/rubocop/cops/empty_lines_spec.rb
 - spec/rubocop/cops/encoding_spec.rb
 - spec/rubocop/cops/end_of_line_spec.rb
+- spec/rubocop/cops/favor_modifier_spec.rb
 - spec/rubocop/cops/grammar_spec.rb
 - spec/rubocop/cops/hash_syntax_spec.rb
 - spec/rubocop/cops/if_with_semicolon_spec.rb
@@ -217,7 +219,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1293678541270492107
+      hash: -1525847250123006446
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: