tailor 1.0.1 → 1.1.0

data/lib/tailor/tailorrc.erb

@@ -82,6 +82,6 @@
 Tailor.config do |config|
   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 %>
+    style.<%= rule %> <%= value.first %>, <% value.last.each { |k, v| %><%= k %>: :<%= v %><% } end %>
   end
 end

data/lib/tailor/version.rb

@@ -1,3 +1,3 @@
 class Tailor
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 end

data/spec/functional/configuration_spec.rb

@@ -0,0 +1,244 @@
+require_relative '../spec_helper'
+require 'tailor/configuration'
+
+describe "Config File" do
+  before do
+    Tailor::Logger.stub(:log)
+    FakeFS.deactivate!
+  end
+
+  after do
+    FakeFS.activate!
+  end
+
+  context "files aren't given at runtime" do
+    let(:config) do
+      config = Tailor::Configuration.new
+      config.load!
+
+      config
+    end
+
+    context ".tailor does not exist" do
+      before do
+        Tailor::Configuration.any_instance.stub(:config_file).and_return false
+      end
+
+      it "sets formatters to 'text'" do
+        config.formatters.should == %w(text)
+      end
+
+      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
+        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
+        let(:config_file) do
+          <<-CONFIG
+Tailor.config do |config|
+  config.file_set 'lib/**/*.rb'
+
+  config.file_set 'features/**/*.rb', :features do |style|
+    style.max_line_length 90, level: :warn
+  end
+end
+          CONFIG
+        end
+
+        before do
+          File.should_receive(:read).and_return config_file
+        end
+
+        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
+          style = Tailor::Configuration::Style.new
+          style.max_line_length(90, level: :warn)
+          config.file_sets[:features].style.should == style.to_hash
+          config.file_sets[:features].file_list.all? do |path|
+            path =~ /features/
+          end.should be_true
+        end
+      end
+    end
+
+    context ".tailor defines NO default file set" do
+      let(:config_file) do
+        <<-CONFIG
+Tailor.config do |config|
+  config.file_set 'features/**/*.rb', :features do |style|
+    style.max_line_length 90, level: :warn
+  end
+end
+        CONFIG
+      end
+
+      before do
+        File.should_receive(:read).and_return config_file
+      end
+
+      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
+        config.file_sets.should include :features
+      end
+    end
+
+    context '.tailor defines a single recursive file set' do
+      let(:config_file) do
+        <<-CONFIG
+Tailor.config do |config|
+  config.recursive_file_set '*spec.rb' do |style|
+    style.max_line_length 90, level: :warn
+  end
+end
+        CONFIG
+      end
+
+      before do
+        File.should_receive(:read).and_return config_file
+      end
+
+      it 'creates a :default file set' do
+        config.file_sets.keys.should == [:default]
+      end
+
+      it 'has files in the file list levels deep' do
+        config.file_sets[:default].file_list.all? do |file|
+          file =~ /spec\.rb$/
+        end.should be_true
+      end
+    end
+  end
+
+  context 'files are given at runtime' do
+    let(:config) do
+      config = Tailor::Configuration.new('lib/tailor.rb')
+      config.load!
+
+      config
+    end
+
+    context ".tailor does not exist" do
+      before do
+        Tailor::Configuration.any_instance.stub(:config_file).and_return false
+      end
+
+      it "sets formatters to 'text'" do
+        config.formatters.should == %w(text)
+      end
+
+      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
+        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
+        let(:config_file) do
+          <<-CONFIG
+Tailor.config do |config|
+  config.file_set 'lib/**/*.rb' do |style|
+    style.max_line_length 85
+  end
+
+  config.file_set 'features/**/*.rb', :features do |style|
+    style.max_line_length 90, level: :warn
+  end
+end
+          CONFIG
+        end
+
+        before do
+          File.should_receive(:read).and_return config_file
+        end
+
+        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
+          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 :features file set" do
+          config.file_sets.should_not include :features
+        end
+      end
+    end
+
+    context ".tailor defines NO default file set" do
+      let(:config_file) do
+        <<-CONFIG
+Tailor.config do |config|
+  config.file_set 'features/**/*.rb', :features do |style|
+    style.max_line_length 90, level: :warn
+  end
+end
+        CONFIG
+      end
+
+      before do
+        File.should_receive(:read).and_return config_file
+      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
+        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
+        config.file_sets.should_not include :features
+      end
+    end
+
+    context '.tailor defines a single recursive file set' do
+      let(:config_file) do
+        <<-CONFIG
+Tailor.config do |config|
+  config.recursive_file_set '*_spec.rb' do |style|
+    style.max_line_length 90, level: :warn
+  end
+end
+        CONFIG
+      end
+
+      before do
+        File.should_receive(:read).and_return config_file
+      end
+
+      it 'creates a :default file set' do
+        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
+        config.file_sets[:default].file_list.size.should be 1
+        config.file_sets[:default].file_list.first.match /lib\/tailor\.rb$/
+      end
+    end
+  end
+end

data/spec/functional/horizontal_spacing/braces_spec.rb

@@ -0,0 +1,238 @@
+require_relative '../../spec_helper'
+require 'tailor/critic'
+require 'tailor/configuration/style'
+
+BRACES = {}
+BRACES[:single_line_hash_0_spaces_before_lbrace] =
+  %Q{thing ={ :one => 'one' }}
+
+BRACES[:single_line_hash_2_spaces_before_lbrace] =
+  %Q{thing =  { :one => 'one' }}
+
+BRACES[:single_line_hash_2_spaces_before_rbrace] =
+  %Q{thing = { :one => 'one'  }}
+
+BRACES[:single_line_hash_2_spaces_after_lbrace] =
+  %Q{thing = {  :one => 'one' }}
+
+BRACES[:two_line_hash_2_spaces_before_lbrace] = %Q{thing1 =
+  thing2 =  { :one => 'one' }}
+
+BRACES[:two_line_hash_2_spaces_before_rbrace] = %Q{thing1 =
+  thing2 = { :one => 'one'  }}
+
+BRACES[:two_line_hash_2_spaces_before_lbrace_lonely_braces] =
+  %Q{thing1 =
+  thing2 =  {
+    :one => 'one'
+  }}
+
+BRACES[:space_in_empty_hash_in_string_in_block] =
+  %Q{[1].map { |n| { :first => "\#{n}-\#{{ }}" } }}
+
+BRACES[:single_line_block_2_spaces_before_lbrace] =
+  %Q{1..10.times  { |n| puts n }}
+
+BRACES[:single_line_block_in_string_interp_2_spaces_before_lbrace] =
+  %Q{"I did this \#{1..10.times  { |n| puts n }} times."}
+
+BRACES[:single_line_block_0_spaces_before_lbrace] =
+  %Q{1..10.times{ |n| puts n }}
+
+BRACES[:two_line_braces_block_2_spaces_before_lbrace] =
+  %Q{1..10.times  { |n|
+  puts n}}
+
+BRACES[:two_line_braces_block_0_spaces_before_lbrace_trailing_comment] =
+  %Q{1..10.times{ |n|    # comment
+  puts n}}
+
+BRACES[:no_space_after_l_before_r_after_string_interp] =
+  %Q{logger.debug "from \#{current} to \#{new_ver}", {:format => :short}}
+
+BRACES[:no_space_before_consecutive_rbraces] =
+  %Q{thing = { 'id' => "\#{source}", 'attributes' => { 'height' => "\#{height}"}}}
+
+describe "Detection of spacing around braces" do
+  before do
+    Tailor::Logger.stub(:log)
+    FakeFS.activate!
+    File.open(file_name.to_s, 'w') { |f| f.write contents }
+    critic.check_file(file_name.to_s, style.to_hash)
+  end
+
+  let(:critic) do
+    Tailor::Critic.new
+  end
+
+  let(:contents) { BRACES[file_name]}
+
+  let(:style) do
+    style = Tailor::Configuration::Style.new
+    style.trailing_newlines 0, level: :off
+    style.allow_invalid_ruby true, level: :off
+
+    style
+  end
+
+  context "single-line Hash" do
+    context "0 spaces before lbrace" do
+      let(:file_name) { :single_line_hash_0_spaces_before_lbrace }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "spaces_before_lbrace" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 1 }
+      specify { critic.problems[file_name.to_s].first[:column].should be 7 }
+      specify { critic.problems[file_name.to_s].first[:level].should be :error }
+    end
+
+    context "2 spaces before lbrace" do
+      let(:file_name) { :single_line_hash_2_spaces_before_lbrace }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "spaces_before_lbrace" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 1 }
+      specify { critic.problems[file_name.to_s].first[:column].should be 9 }
+      specify { critic.problems[file_name.to_s].first[:level].should be :error }
+    end
+
+    context "2 spaces after lbrace" do
+      let(:file_name) { :single_line_hash_2_spaces_after_lbrace }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "spaces_after_lbrace" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 1 }
+      specify { critic.problems[file_name.to_s].first[:column].should be 9 }
+      specify { critic.problems[file_name.to_s].first[:level].should be :error }
+    end
+
+    context "2 spaces before rbrace" do
+      let(:file_name) { :single_line_hash_2_spaces_before_rbrace }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "spaces_before_rbrace" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 1 }
+      specify { critic.problems[file_name.to_s].first[:column].should be 25 }
+      specify { critic.problems[file_name.to_s].first[:level].should be :error }
+    end
+  end
+
+  context "two-line Hash" do
+    context "2 spaces before lbrace" do
+      let(:file_name) { :two_line_hash_2_spaces_before_lbrace }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "spaces_before_lbrace" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 2 }
+      specify { critic.problems[file_name.to_s].first[:column].should be 12 }
+      specify { critic.problems[file_name.to_s].first[:level].should be :error }
+    end
+
+    context "2 spaces before rbrace" do
+      let(:file_name) { :two_line_hash_2_spaces_before_rbrace }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "spaces_before_rbrace" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 2 }
+      specify { critic.problems[file_name.to_s].first[:column].should be 28 }
+      specify { critic.problems[file_name.to_s].first[:level].should be :error }
+    end
+
+    context "2 spaces before lbrace, lonely braces" do
+      let(:file_name) { :two_line_hash_2_spaces_before_lbrace_lonely_braces }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "spaces_before_lbrace" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 2 }
+      specify { critic.problems[file_name.to_s].first[:column].should be 12 }
+      specify { critic.problems[file_name.to_s].first[:level].should be :error }
+    end
+  end
+
+  context "single-line block" do
+    context "space in empty Hash" do
+      let(:file_name) { :space_in_empty_hash_in_string_in_block }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "spaces_in_empty_braces" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 1 }
+      specify { critic.problems[file_name.to_s].first[:column].should be 36 }
+      specify { critic.problems[file_name.to_s].first[:level].should be :error }
+    end
+
+    context "0 spaces before lbrace" do
+      let(:file_name) { :single_line_block_0_spaces_before_lbrace }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "spaces_before_lbrace" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 1 }
+      specify { critic.problems[file_name.to_s].first[:column].should be 11 }
+      specify { critic.problems[file_name.to_s].first[:level].should be :error }
+    end
+
+    context "2 spaces before lbrace" do
+      let(:file_name) { :single_line_block_2_spaces_before_lbrace }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "spaces_before_lbrace" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 1 }
+      specify { critic.problems[file_name.to_s].first[:column].should be 13 }
+      specify { critic.problems[file_name.to_s].first[:level].should be :error }
+    end
+
+    context "in String interpolation, 2 spaces before lbrace" do
+      let(:file_name) { :single_line_block_in_string_interp_2_spaces_before_lbrace }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "spaces_before_lbrace" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 1 }
+      specify { critic.problems[file_name.to_s].first[:column].should be 27 }
+      specify { critic.problems[file_name.to_s].first[:level].should be :error }
+    end
+  end
+
+  context "multi-line block" do
+    context "2 spaces before lbrace" do
+      let(:file_name) { :two_line_braces_block_2_spaces_before_lbrace }
+      specify { critic.problems[file_name.to_s].size.should be 2 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "spaces_before_lbrace" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 1 }
+      specify { critic.problems[file_name.to_s].first[:column].should be 13 }
+      specify { critic.problems[file_name.to_s].first[:level].should be :error }
+      specify { critic.problems[file_name.to_s].last[:type].should == "spaces_before_rbrace" }
+      specify { critic.problems[file_name.to_s].last[:line].should be 2 }
+      specify { critic.problems[file_name.to_s].last[:column].should be 8 }
+      specify { critic.problems[file_name.to_s].last[:level].should be :error }
+    end
+
+    context "0 spaces before lbrace, with trailing comment" do
+      let(:file_name) { :two_line_braces_block_0_spaces_before_lbrace_trailing_comment }
+      specify { critic.problems[file_name.to_s].size.should be 2 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "spaces_before_lbrace" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 1 }
+      specify { critic.problems[file_name.to_s].first[:column].should be 11 }
+      specify { critic.problems[file_name.to_s].first[:level].should be :error }
+      specify { critic.problems[file_name.to_s].last[:type].should == "spaces_before_rbrace" }
+      specify { critic.problems[file_name.to_s].last[:line].should be 2 }
+      specify { critic.problems[file_name.to_s].last[:column].should be 8 }
+      specify { critic.problems[file_name.to_s].last[:level].should be :error }
+    end
+  end
+
+  context "String interpolation" do
+    context "0 spaces after lbrace or before rbrace" do
+      let(:file_name) { :no_space_after_l_before_r_after_string_interp }
+      specify { critic.problems[file_name.to_s].size.should be 2 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "spaces_after_lbrace" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 1 }
+      specify { critic.problems[file_name.to_s].first[:column].should be 47 }
+      specify { critic.problems[file_name.to_s].first[:level].should be :error }
+      specify { critic.problems[file_name.to_s].last[:type].should == "spaces_before_rbrace" }
+      specify { critic.problems[file_name.to_s].last[:line].should be 1 }
+      specify { critic.problems[file_name.to_s].last[:column].should be 64 }
+      specify { critic.problems[file_name.to_s].last[:level].should be :error }
+    end
+
+    context "no space before consecutive rbraces" do
+      let(:file_name) { :no_space_before_consecutive_rbraces }
+      specify { critic.problems[file_name.to_s].size.should be 2 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "spaces_before_rbrace" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 1 }
+      specify { critic.problems[file_name.to_s].first[:column].should be 72 }
+      specify { critic.problems[file_name.to_s].first[:level].should be :error }
+      specify { critic.problems[file_name.to_s].last[:type].should == "spaces_before_rbrace" }
+      specify { critic.problems[file_name.to_s].last[:line].should be 1 }
+      specify { critic.problems[file_name.to_s].last[:column].should be 73 }
+      specify { critic.problems[file_name.to_s].last[:level].should be :error }
+    end
+  end
+end