tailor 1.2.1 → 1.3.0

data/lib/tailor/rulers/spaces_before_rbracket_ruler.rb

@@ -3,11 +3,11 @@ require_relative '../ruler'
 class Tailor
   module Rulers
 
-    # Checks for spaces before a ']' as given by +@config+.  It skips checking
+    # Checks for spaces before a +]+ as given by +@config+.  It skips checking
     # when:
     # * it's the first char in the line.
-    # * it's directly preceded by a '['.
-    # * it's directly preceded by spaces, then a '['.
+    # * it's directly preceded by a +[+.
+    # * it's directly preceded by spaces, then a +[+.
     class SpacesBeforeRbracketRuler < Tailor::Ruler
       def initialize(config, options)
         super(config, options)
@@ -53,8 +53,8 @@ class Tailor
         end
       end
 
-      # This has to keep track of '{'s and only follow through with the check
-      # if the '{' was an lbrace because Ripper doesn't scan the '}' of an
+      # This has to keep track of +{+s and only follow through with the check
+      # if the +{+ was an lbrace because Ripper doesn't scan the +}+ of an
       # embedded expression (embexpr_end) as such.
       #
       # @param [Tailor::LexedLine] lexed_line
@@ -64,7 +64,7 @@ class Tailor
         count = count_spaces(lexed_line, column)
 
         if count.nil?
-          log "rbracket must be at the beginning of the line."
+          log 'rbracket must be at the beginning of the line.'
           return
         else
           log "Found #{count} space(s) before rbracket."

data/lib/tailor/rulers/spaces_before_rparen_ruler.rb

@@ -6,8 +6,8 @@ class Tailor
     # Checks for spaces before a +)+ as given by +@config+.  It skips checking
     # when:
     # * it's the first char in the line.
-    # * it's directly preceded by a '('.
-    # * it's directly preceded by spaces, then a '('.
+    # * it's directly preceded by a +(+.
+    # * it's directly preceded by spaces, then a +(+.
     class SpacesBeforeRparenRuler < Tailor::Ruler
       def initialize(config, options)
         super(config, options)
@@ -16,7 +16,7 @@ class Tailor
 
       # @param [LexedLine] lexed_line
       # @param [Fixnum] column
-      # @return [Fixnum] The number of spaces before the rparen.
+      # @return [Fixnum] the number of spaces before the rparen.
       def count_spaces(lexed_line, column)
         current_index = lexed_line.event_index(column)
         log "Current event index: #{current_index}"
@@ -53,8 +53,8 @@ class Tailor
         end
       end
 
-      # This has to keep track of '{'s and only follow through with the check
-      # if the '{' was an lbrace because Ripper doesn't scan the '}' of an
+      # This has to keep track of +{+s and only follow through with the check
+      # if the +{+ was an lbrace because Ripper doesn't scan the +}+ of an
       # embedded expression (embexpr_end) as such.
       #
       # @param [Tailor::LexedLine] lexed_line
@@ -64,7 +64,7 @@ class Tailor
         count = count_spaces(lexed_line, column)
 
         if count.nil?
-          log "rparen must be at the beginning of the line."
+          log 'rparen must be at the beginning of the line.'
           return
         else
           log "Found #{count} space(s) before rparen."

data/lib/tailor/rulers/spaces_in_empty_braces_ruler.rb

@@ -68,7 +68,7 @@ class Tailor
         end
       end
 
-      # This has to keep track of '{'s and only follow through with the check
+      # This has to keep track of +{+s and only follow through with the check
       # if the +{+ was an lbrace because Ripper doesn't scan the +}+ of an
       # embedded expression (embexpr_end) as such.
       #

data/lib/tailor/rulers/trailing_newlines_ruler.rb

@@ -16,8 +16,8 @@ class Tailor
       #   of the file.
       def measure(trailing_newline_count)
         if trailing_newline_count != @config
-          lineno = "<EOF>"
-          column = "<EOF>"
+          lineno = '<EOF>'
+          column = '<EOF>'
           msg = "File has #{trailing_newline_count} trailing "
           msg << "newlines, but should have #{@config}."
 

data/lib/tailor/tailorrc.erb

@@ -80,7 +80,7 @@
 #                         Default:      1
 #
 Tailor.config do |config|
-  config.formatters "<%= formatters.join(", ") %>"
+  config.formatters "<%= formatters.join(', ') %>"
   config.file_set '<%= file_list %>' do |style|<% style.each do |rule, value| %>
     style.<%= rule %> <%= value.first %>, <% value.last.each { |k, v| %><%= k %>: :<%= v %><% } end %>
   end

data/lib/tailor/version.rb

@@ -1,3 +1,3 @@
 class Tailor
-  VERSION = '1.2.1'
+  VERSION = '1.3.0'
 end

data/spec/functional/conditional_spacing_spec.rb

@@ -0,0 +1,149 @@
+require 'spec_helper'
+require_relative '../support/conditional_spacing_cases'
+require 'tailor/critic'
+require 'tailor/configuration/style'
+
+describe 'Conditional spacing' do
+
+  def file_name
+    self.class.description
+  end
+
+  def contents
+    CONDITIONAL_SPACING[file_name] || begin
+      raise "Example not found: #{file_name}"
+    end
+  end
+
+  before do
+    Tailor::Logger.stub(:log)
+    FakeFS.activate!
+    FileUtils.touch file_name
+    File.open(file_name, 'w') { |f| f.write contents }
+  end
+
+  let(:critic) { Tailor::Critic.new }
+
+  let(:style) do
+    style = Tailor::Configuration::Style.new
+    style.trailing_newlines 0, level: :off
+    style.allow_invalid_ruby true, level: :off
+    style
+  end
+
+  context :no_space_after_if do
+    it 'warns when there is no space after an if statement' do
+      critic.check_file(file_name, style.to_hash)
+      expect(critic.problems[file_name]).to eql [{
+        :type => 'spaces_after_conditional',
+        :line => 1,
+        :column => 0,
+        :message => '0 spaces after conditional at column 0, expected 1.',
+        :level => :error
+      }]
+    end
+
+    it 'warns with the correct number of expected spaces' do
+      style.spaces_after_conditional 2, level: :error
+      critic.check_file(file_name, style.to_hash)
+      expect(critic.problems[file_name]).to eql [{
+        :type => 'spaces_after_conditional',
+        :line => 1,
+        :column => 0,
+        :message => '0 spaces after conditional at column 0, expected 2.',
+        :level => :error
+      }]
+    end
+
+    it 'does not warn if spaces are set to zero' do
+      style.spaces_after_conditional 0, level: :error
+      critic.check_file(file_name, style.to_hash)
+      expect(critic.problems[file_name]).to be_empty
+    end
+
+    it 'does not warn if spaces are disabled' do
+      style.spaces_after_conditional 2, level: :off
+      critic.check_file(file_name, style.to_hash)
+      expect(critic.problems[file_name]).to be_empty
+    end
+  end
+
+  context :space_after_if do
+    it 'does not warn when there is a space after the if' do
+      critic.check_file(file_name, style.to_hash)
+      expect(critic.problems[file_name]).to be_empty
+    end
+
+    it 'warns if spaces has been set to zero' do
+      style.spaces_after_conditional 0, level: :error
+      critic.check_file(file_name, style.to_hash)
+      expect(critic.problems[file_name]).to eql [{
+        :type => 'spaces_after_conditional',
+        :line => 1,
+        :column => 0,
+        :message => '1 spaces after conditional at column 0, expected 0.',
+        :level => :error
+      }]
+    end
+  end
+
+  context :no_parens do
+    it 'never warns' do
+      critic.check_file(file_name, style.to_hash)
+      expect(critic.problems[file_name]).to be_empty
+    end
+  end
+
+  context :nested_parens do
+    it 'warns when there is no space after an if statement' do
+      critic.check_file(file_name, style.to_hash)
+      expect(critic.problems[file_name]).to eql [{
+        :type => 'spaces_after_conditional',
+        :line => 1,
+        :column => 0,
+        :message => '0 spaces after conditional at column 0, expected 1.',
+        :level => :error
+      }]
+    end
+  end
+
+  context :no_space_after_unless do
+    it 'warns when there is no space after an unless statement' do
+      critic.check_file(file_name, style.to_hash)
+      expect(critic.problems[file_name]).to eql [{
+        :type => 'spaces_after_conditional',
+        :line => 1,
+        :column => 0,
+        :message => '0 spaces after conditional at column 0, expected 1.',
+        :level => :error
+      }]
+    end
+  end
+
+  context :space_after_unless do
+    it 'does not warn when there is space after an unless statement' do
+      critic.check_file(file_name, style.to_hash)
+      expect(critic.problems[file_name]).to be_empty
+    end
+  end
+
+  context :no_space_after_case do
+    it 'warns when there is no space after a case statement' do
+      critic.check_file(file_name, style.to_hash)
+      expect(critic.problems[file_name]).to eql [{
+        :type => 'spaces_after_conditional',
+        :line => 1,
+        :column => 5,
+        :message => '0 spaces after conditional at column 5, expected 1.',
+        :level => :error
+      }]
+    end
+  end
+
+  context :space_after_case do
+    it 'does not warn when there is space after a case statement' do
+      critic.check_file(file_name, style.to_hash)
+      expect(critic.problems[file_name]).to be_empty
+    end
+  end
+end

data/spec/functional/configuration_spec.rb

@@ -1,7 +1,8 @@
-require_relative '../spec_helper'
+require 'spec_helper'
 require 'tailor/configuration'
 
-describe "Config File" do
+
+describe 'Config File' do
   before do
     Tailor::Logger.stub(:log)
     FakeFS.deactivate!
@@ -11,7 +12,7 @@ describe "Config File" do
     FakeFS.activate!
   end
 
-  context "files aren't given at runtime" do
+  context 'files are not given at runtime' do
     let(:config) do
       config = Tailor::Configuration.new
       config.load!
@@ -19,7 +20,7 @@ describe "Config File" do
       config
     end
 
-    context ".tailor does not exist" do
+    context '.tailor does not exist' do
       before do
         Tailor::Configuration.any_instance.stub(:config_file).and_return false
       end
@@ -28,20 +29,20 @@ describe "Config File" do
         config.formatters.should == %w(text)
       end
 
-      it "sets file_sets[:default].style to the default style" do
+      it 'sets file_sets[:default].style to the default style' do
         config.file_sets[:default].style.should_not be_nil
         config.file_sets[:default].style.should == Tailor::Configuration::Style.new.to_hash
       end
 
-      it "sets file_sets[:default].file_list to the files in lib/**/*.rb" do
+      it 'sets file_sets[:default].file_list to the files in lib/**/*.rb' do
         config.file_sets[:default].file_list.all? do |path|
           path =~ /tailor\/lib/
         end.should be_true
       end
     end
 
-    context ".tailor defines the default file set" do
-      context "and another file set" do
+    context '.tailor defines the default file set' do
+      context 'and another file set' do
         let(:config_file) do
           <<-CONFIG
 Tailor.config do |config|
@@ -58,14 +59,14 @@ end
           File.should_receive(:read).and_return config_file
         end
 
-        it "creates the default file set" do
+        it 'creates the default file set' do
           config.file_sets[:default].style.should == Tailor::Configuration::Style.new.to_hash
           config.file_sets[:default].file_list.all? do |path|
             path =~ /tailor\/lib/
           end.should be_true
         end
 
-        it "creates the :features file set" do
+        it 'creates the :features file set' do
           style = Tailor::Configuration::Style.new
           style.max_line_length(90, level: :warn)
           config.file_sets[:features].style.should == style.to_hash
@@ -76,7 +77,7 @@ end
       end
     end
 
-    context ".tailor defines NO default file set" do
+    context '.tailor defines NO default file set' do
       let(:config_file) do
         <<-CONFIG
 Tailor.config do |config|
@@ -91,11 +92,11 @@ end
         File.should_receive(:read).and_return config_file
       end
 
-      it "does not create a :default file set" do
+      it 'does not create a :default file set' do
         config.file_sets.should_not include :default
       end
 
-      it "creates the non-default file set" do
+      it 'creates the non-default file set' do
         config.file_sets.should include :features
       end
     end
@@ -124,6 +125,12 @@ end
           file =~ /spec\.rb$/
         end.should be_true
       end
+
+      it 'applies the nested configuration within the fileset' do
+        expect(config.file_sets[:default].style[
+          :max_line_length]).to eql [90, { :level => :warn }]
+      end
+
     end
   end
 
@@ -135,7 +142,7 @@ end
       config
     end
 
-    context ".tailor does not exist" do
+    context '.tailor does not exist' do
       before do
         Tailor::Configuration.any_instance.stub(:config_file).and_return false
       end
@@ -144,19 +151,19 @@ end
         config.formatters.should == %w(text)
       end
 
-      it "sets file_sets[:default].style to the default style" do
+      it 'sets file_sets[:default].style to the default style' do
         config.file_sets[:default].style.should_not be_nil
         config.file_sets[:default].style.should == Tailor::Configuration::Style.new.to_hash
       end
 
-      it "sets file_sets[:default].file_list to the runtime files" do
+      it 'sets file_sets[:default].file_list to the runtime files' do
         config.file_sets[:default].file_list.size.should be 1
         config.file_sets[:default].file_list.first.match /lib\/tailor\.rb$/
       end
     end
 
-    context ".tailor defines the default file set" do
-      context "and another file set" do
+    context '.tailor defines the default file set' do
+      context 'and another file set' do
         let(:config_file) do
           <<-CONFIG
 Tailor.config do |config|
@@ -175,7 +182,7 @@ end
           File.should_receive(:read).and_return config_file
         end
 
-        it "creates the default file set using the runtime files" do
+        it 'creates the default file set using the runtime files' do
           style = Tailor::Configuration::Style.new
           style.max_line_length 85
           config.file_sets[:default].style.should == style.to_hash
@@ -183,13 +190,13 @@ end
           config.file_sets[:default].file_list.first.match /lib\/tailor\.rb$/
         end
 
-        it "does not create the :features file set" do
+        it 'does not create the :features file set' do
           config.file_sets.should_not include :features
         end
       end
     end
 
-    context ".tailor defines NO default file set" do
+    context '.tailor defines NO default file set' do
       let(:config_file) do
         <<-CONFIG
 Tailor.config do |config|
@@ -204,13 +211,13 @@ end
         File.should_receive(:read).and_return config_file
       end
 
-      it "creates a :default file set with the runtime file and default style" do
+      it 'creates a :default file set with the runtime file and default style' do
         config.file_sets[:default].style.should == Tailor::Configuration::Style.new.to_hash
         config.file_sets[:default].file_list.size.should be 1
         config.file_sets[:default].file_list.first.match /lib\/tailor\.rb$/
       end
 
-      it "does not create the non-default file set" do
+      it 'does not create the non-default file set' do
         config.file_sets.should_not include :features
       end
     end
@@ -234,8 +241,11 @@ end
         config.file_sets.keys.should == [:default]
       end
 
-      it "creates a :default file set with the runtime file and default style" do
-        config.file_sets[:default].style.should == Tailor::Configuration::Style.new.to_hash
+      it 'creates a :default file set with the runtime file and default style' do
+        style = Tailor::Configuration::Style.new.tap do |style|
+          style.max_line_length 90, level: :warn
+        end.to_hash
+        config.file_sets[:default].style.should == style
         config.file_sets[:default].file_list.size.should be 1
         config.file_sets[:default].file_list.first.match /lib\/tailor\.rb$/
       end
@@ -272,7 +282,7 @@ end
         File.should_receive(:read).and_return config_file
       end
 
-      it "sets formatters to the defined" do
+      it 'sets formatters to the defined' do
         config.formatters.should == %w(yaml text)
       end