tailor 1.1.5 → 1.2.0

data/spec/support/horizontal_spacing_cases.rb

@@ -1,12 +1,12 @@
 H_SPACING_OK = {}
 
-H_SPACING_OK[:short_line_no_newline] = '#' * 79
-H_SPACING_OK[:short_line_newline_at_81] =
+H_SPACING_OK['short_line_no_newline'] = '#' * 79
+H_SPACING_OK['short_line_newline_at_81'] =
   %Q{'#{'#' * 78}'
 }
 
 =begin
-H_SPACING_OK[:line_split_by_backslash] =
+H_SPACING_OK['line_split_by_backslash'] =
   %Q{execute 'myscript' do
   command \\
     '/some/really/long/path/that/would/be/over/eight/chars.sh'
@@ -17,49 +17,49 @@ end}
 #-------------------------------------------------------------------------------
 # Comma spacing
 #-------------------------------------------------------------------------------
-H_SPACING_OK[:space_after_comma_in_array] = %Q{[1, 2]}
+H_SPACING_OK['space_after_comma_in_array'] = %Q{[1, 2]}
 
-H_SPACING_OK[:trailing_comma] = %Q{def thing(one, two,
+H_SPACING_OK['trailing_comma'] = %Q{def thing(one, two,
   three)
 end}
 
-H_SPACING_OK[:trailing_comma_with_trailing_comment] =
+H_SPACING_OK['trailing_comma_with_trailing_comment'] =
   %Q{def thing(one, two,  # Comment!
   three)
 end}
 
-H_SPACING_OK[:no_before_comma_in_array] = %Q{[1, 2]}
-H_SPACING_OK[:line_ends_with_backslash] =
+H_SPACING_OK['no_before_comma_in_array'] = %Q{[1, 2]}
+H_SPACING_OK['line_ends_with_backslash'] =
   %Q{{ :thing => a_thing,\\
   :thing2 => another_thing }}
 
 #-------------------------------------------------------------------------------
 # Braces
 #-------------------------------------------------------------------------------
-H_SPACING_OK[:empty_hash] = %Q{{}}
-H_SPACING_OK[:single_line_hash] = %Q{{ :one => 'one' }}
-H_SPACING_OK[:single_line_hash_lonely_braces] = %Q{{
+H_SPACING_OK['empty_hash'] = %Q{{}}
+H_SPACING_OK['single_line_hash'] = %Q{{ :one => 'one' }}
+H_SPACING_OK['single_line_hash_lonely_braces'] = %Q{{
   :one => 'one'
 }}
 
-H_SPACING_OK[:hash_as_param_in_parens] =
+H_SPACING_OK['hash_as_param_in_parens'] =
   %Q{add_headers({ content_length: new_body.length })}
 
-H_SPACING_OK[:two_line_hash] = %Q{{ :one =>
+H_SPACING_OK['two_line_hash'] = %Q{{ :one =>
   'one' }}
 
-H_SPACING_OK[:two_line_hash_trailing_comment] = %Q{{ :one =>    # comment
+H_SPACING_OK['two_line_hash_trailing_comment'] = %Q{{ :one =>    # comment
   'one' }}
 
-H_SPACING_OK[:three_line_hash] = %Q{{ :one =>
+H_SPACING_OK['three_line_hash'] = %Q{{ :one =>
   'one', :two =>
   'two' }}
 
-H_SPACING_OK[:single_line_block] = %Q{1..10.times { |n| puts number }}
-H_SPACING_OK[:multi_line_braces_block] = %Q{1..10.times { |n|
+H_SPACING_OK['single_line_block'] = %Q{1..10.times { |n| puts number }}
+H_SPACING_OK['multi_line_braces_block'] = %Q{1..10.times { |n|
   puts number }}
 
-H_SPACING_OK[:multi_line_qword_using_braces] = %Q{%w{
+H_SPACING_OK['multi_line_qword_using_braces'] = %Q{%w{
   foo
   bar
   baz
@@ -67,26 +67,26 @@ H_SPACING_OK[:multi_line_qword_using_braces] = %Q{%w{
   bla
 end}
 
-H_SPACING_OK[:empty_hash_in_multi_line_statement] =
+H_SPACING_OK['empty_hash_in_multi_line_statement'] =
   %Q{if true
   {}
 end}
 
-H_SPACING_OK[:multi_line_hash_in_multi_line_statement] =
+H_SPACING_OK['multi_line_hash_in_multi_line_statement'] =
   %Q{if true
   options = {
     one: 1
   }
 end}
 
-H_SPACING_OK[:single_line_string_interp] = %Q{`\#{IFCONFIG} | grep \#{ip}`}
-H_SPACING_OK[:single_line_block_in_string_interp] =
+H_SPACING_OK['single_line_string_interp'] = %Q{`\#{IFCONFIG} | grep \#{ip}`}
+H_SPACING_OK['single_line_block_in_string_interp'] =
   %Q{"I did this \#{1..10.times { |n| n }} times."}
 
-H_SPACING_OK[:empty_hash_in_string_in_block] =
+H_SPACING_OK['empty_hash_in_string_in_block'] =
   %Q{[1].map { |n| { :first => "\#{n}-\#{{}}" } }}
 
-H_SPACING_OK[:string_interp_with_colonop] =
+H_SPACING_OK['string_interp_with_colonop'] =
   %Q{"\#{::Rails.root}"}
 
 
@@ -94,23 +94,23 @@ H_SPACING_OK[:string_interp_with_colonop] =
 #-------------------------------------------------------------------------------
 # Brackets
 #-------------------------------------------------------------------------------
-H_SPACING_OK[:empty_array] = %Q{[]}
-H_SPACING_OK[:simple_array] = %Q{[1, 2, 3]}
-H_SPACING_OK[:two_d_array] = %Q{[[1, 2, 3], ['a', 'b', 'c']]}
-H_SPACING_OK[:hash_key_reference] = %Q{thing[:one]}
-H_SPACING_OK[:array_of_symbols] =
+H_SPACING_OK['empty_array'] = %Q{[]}
+H_SPACING_OK['simple_array'] = %Q{[1, 2, 3]}
+H_SPACING_OK['two_d_array'] = %Q{[[1, 2, 3], ['a', 'b', 'c']]}
+H_SPACING_OK['hash_key_reference'] = %Q{thing[:one]}
+H_SPACING_OK['array_of_symbols'] =
   %Q{transition [:active, :reactivated] => :opened}
-H_SPACING_OK[:array_of_hashes] =
+H_SPACING_OK['array_of_hashes'] =
   %Q{[ { :one => [[1, 2, 3], ['a', 'b', 'c']] },
   { :two => [[4, 5, 6], ['d', 'e', 'f']] }]}
 
-H_SPACING_OK[:simple_array_lonely_brackets] =
+H_SPACING_OK['simple_array_lonely_brackets'] =
   %Q{[
   1, 2,
   3
 ]}
 
-H_SPACING_OK[:simple_nested_array_lonely_brackets] =
+H_SPACING_OK['simple_nested_array_lonely_brackets'] =
   %Q{def thing
   [
     1, 2,
@@ -119,7 +119,7 @@ H_SPACING_OK[:simple_nested_array_lonely_brackets] =
 end}
 
 
-H_SPACING_OK[:empty_array_in_multi_line_statement] =
+H_SPACING_OK['empty_array_in_multi_line_statement'] =
   %Q{if true
   []
 end}
@@ -127,10 +127,10 @@ end}
 #-------------------------------------------------------------------------------
 # Parens
 #-------------------------------------------------------------------------------
-H_SPACING_OK[:empty_parens] = %Q{def thing(); end}
-H_SPACING_OK[:simple_method_call] = %Q{thing(one, two)}
-H_SPACING_OK[:multi_line_method_call] = %Q{thing(one,
+H_SPACING_OK['empty_parens'] = %Q{def thing(); end}
+H_SPACING_OK['simple_method_call'] = %Q{thing(one, two)}
+H_SPACING_OK['multi_line_method_call'] = %Q{thing(one,
   two)}
-H_SPACING_OK[:multi_line_method_call_lonely_parens] = %Q{thing(
+H_SPACING_OK['multi_line_method_call_lonely_parens'] = %Q{thing(
   one, two
 )}

data/spec/support/naming_cases.rb

@@ -1,26 +1,26 @@
 NAMING_OK = {}
 
-NAMING_OK[:single_word_method] =
+NAMING_OK['single_word_method'] =
   %Q{def thing
 end}
 
-NAMING_OK[:two_word_method] =
+NAMING_OK['two_word_method'] =
   %Q{def thing_one
 end}
 
 #-------------------------------------------------------------------------------
-NAMING_OK[:single_word_class] =
+NAMING_OK['single_word_class'] =
   %Q{class Thing
 end}
 
-NAMING_OK[:single_word_module] =
+NAMING_OK['single_word_module'] =
   %Q{module Thing
 end}
 
-NAMING_OK[:two_word_class] =
+NAMING_OK['two_word_class'] =
   %Q{class ThingOne
 end}
 
-NAMING_OK[:two_word_module] =
+NAMING_OK['two_word_module'] =
   %Q{module ThingOne
 end}

data/spec/support/vertical_spacing_cases.rb

@@ -3,7 +3,7 @@ V_SPACING_OK = {}
 #-------------------------------------------------------------------------------
 # Class length
 #-------------------------------------------------------------------------------
-V_SPACING_OK[:class_five_code_lines] =
+V_SPACING_OK['class_five_code_lines'] =
   %Q{class Party
   include Clowns
 
@@ -11,7 +11,7 @@ V_SPACING_OK[:class_five_code_lines] =
   end
 end}
 
-V_SPACING_OK[:embedded_class_five_code_lines] =
+V_SPACING_OK['embedded_class_five_code_lines'] =
   %Q{class Party
   class Pizza
     include Cheese
@@ -21,14 +21,14 @@ end}
 #-------------------------------------------------------------------------------
 # Method length
 #-------------------------------------------------------------------------------
-V_SPACING_OK[:method_3_code_lines] =
+V_SPACING_OK['method_3_code_lines'] =
   %Q{def thing
 
 
   puts 'hi'
 end}
 
-V_SPACING_OK[:embedded_method_3_code_lines] =
+V_SPACING_OK['embedded_method_3_code_lines'] =
   %Q{def outter_thing
   def thing; puts 'hi'; end
 

data/spec/unit/tailor/cli_spec.rb

@@ -4,10 +4,10 @@ require 'tailor/cli'
 
 describe Tailor::CLI do
   let(:args) { [] }
-  let(:options) { double "Options", show_config: false }
+  let(:options) { double 'Options', show_config: false }
 
   let(:config) do
-    double "Tailor::Configuration",
+    double 'Tailor::Configuration',
       file_sets: nil, formatters: nil, load!: nil
   end
 
@@ -23,7 +23,7 @@ describe Tailor::CLI do
 
   subject { Tailor::CLI.new(args) }
 
-  describe "::run" do
+  describe '::run' do
     it "creates an instance of Tailor::CLI and calls that object's #execute!" do
       cli = double "Tailor::CLI"
       cli.should_receive(:execute!)
@@ -32,10 +32,10 @@ describe Tailor::CLI do
     end
   end
 
-  describe "#initialize" do
+  describe '#initialize' do
     let(:args) { ['last'] }
 
-    it "uses Options to parse the args" do
+    it 'uses Options to parse the args' do
       Tailor::Configuration.stub(:new).and_return config
       Tailor::Critic.stub(:new)
       Tailor::Reporter.stub(:new)
@@ -44,7 +44,7 @@ describe Tailor::CLI do
       Tailor::CLI.new(args)
     end
 
-    it "creates a new Configuration from the file/dir and options" do
+    it 'creates a new Configuration from the file/dir and options' do
       Tailor::CLI::Options.stub(:parse!).and_return(options)
       Tailor::Configuration.should_receive(:new).
         with(args, options).and_return config
@@ -53,18 +53,18 @@ describe Tailor::CLI do
       Tailor::CLI.new(args)
     end
 
-    context "options.show_config is true" do
+    context 'options.show_config is true' do
 
     end
 
-    context "options.show_config is false" do
+    context 'options.show_config is false' do
 
     end
   end
 
-  describe "#execute!" do
-    let(:reporter) { double "Tailor::Reporter" }
-    let(:critic) { double "Tailor::Critic", problem_count: 0 }
+  describe '#execute!' do
+    let(:reporter) { double 'Tailor::Reporter' }
+    let(:critic) { double 'Tailor::Critic', problem_count: 0 }
 
     before do
       Tailor::Critic.stub(:new).and_return(critic)
@@ -78,9 +78,10 @@ describe Tailor::CLI do
       Tailor::Reporter.unstub(:new)
     end
 
-    it "calls @critic.critique and yields file problems and the label" do
+    it 'calls @critic.critique and yields file problems and the label' do
       problems_for_file = {}
       label = :test
+      config.should_receive(:output_file)
       critic.stub(:problem_count).and_return 1
       critic.stub(:problems)
       critic.stub(:critique).and_yield(problems_for_file, label)
@@ -90,4 +91,25 @@ describe Tailor::CLI do
       subject.execute!
     end
   end
+
+  describe '#result' do
+    let(:critic) { double 'Tailor::Critic', problem_count: 0 }
+
+    before do
+      Tailor::Critic.stub(:new).and_return(critic)
+      subject.instance_variable_set(:@critic, critic)
+    end
+
+    after do
+      Tailor::Critic.unstub(:new)
+    end
+
+    it 'calls @critic.critique and return @critique.problems hash' do
+      problems = {}
+      critic.should_receive(:critique)
+      critic.should_receive(:problems).and_return(problems)
+
+      subject.result.should == problems
+    end
+  end
 end

data/spec/unit/tailor/configuration_spec.rb

@@ -1,5 +1,6 @@
 require_relative '../../spec_helper'
 require 'tailor/configuration'
+require 'tailor/cli'
 
 describe Tailor::Configuration do
   before { Tailor::Logger.stub(:log) }
@@ -105,4 +106,21 @@ describe Tailor::Configuration do
       end
     end
   end
+
+  describe "output file" do
+    context "defined" do
+      subject do
+        parser = Tailor::CLI::Options
+        args = %w(--output-file=tailor-result.yaml)
+        Tailor::Configuration.new(args, parser.parse!(args))
+      end
+
+      before { subject.load! }
+      its(:output_file) { should eq "tailor-result.yaml" }
+    end
+
+    context "not defined" do
+      its(:output_file) { should eq "" }
+    end
+  end
 end

data/spec/unit/tailor/formatters/yaml_spec.rb

@@ -0,0 +1,75 @@
+require_relative '../../../spec_helper'
+require 'tailor/formatters/yaml'
+require 'yaml'
+
+
+describe Tailor::Formatters::Yaml do
+  describe '#summary_report' do
+    context 'no files have problems' do
+      let(:problems) do
+        {
+          '/path_to/file1.rb' => [],
+          '/path_to/file2.rb' => []
+        }
+      end
+
+      it 'returns YAML with no body' do
+        result = subject.summary_report(problems)
+        hash = YAML.load(result)
+        hash.should == {}
+      end
+    end
+
+    context 'one file has one problem' do
+      let(:problems) do
+        {
+          '/path_to/file1.rb' => [{
+            type: 'type1', line: 23, column: 1,
+            message: 'Some message', level: :error
+          }],
+          '/path_to/file2.rb' => []
+        }
+      end
+
+      it 'returns YAML that contains the problem file and its problem' do
+        result = subject.summary_report(problems)
+        hash = YAML.load(result)
+        hash.keys.size.should == 1
+        hash.keys.first.should == '/path_to/file1.rb'
+        hash.should_not include '/path_to/file2.rb'
+        hash['/path_to/file1.rb'].first[:type].should eq 'type1'
+      end
+    end
+
+    context 'one file has one problem, another has two problems' do
+      let(:problems) do
+        {
+          '/path_to/file1.rb' => [{
+            type: 'type1', line: 23, column: 1,
+            message: 'Some message', level: :error
+          }],
+          '/path_to/file2.rb' => [],
+          '/path_to/file3.rb' => [{
+            type: 'type2', line: 45, column: 1,
+            message: 'file 3', level: :off
+          }, {
+            type: 'type3', line: 45, column: 2,
+            message: 'file 3', level: :off
+          }]
+        }
+      end
+
+      it 'returns YAML that contains the problem files and their problems' do
+        result = subject.summary_report(problems)
+        hash = YAML.load(result)
+        hash.keys.size.should == 2
+        hash.keys.first.should == '/path_to/file1.rb'
+        hash.keys.last.should == '/path_to/file3.rb'
+        hash.should_not include '/path_to/file2.rb'
+        hash['/path_to/file1.rb'].first[:type].should eq 'type1'
+        hash['/path_to/file3.rb'].first[:type].should eq 'type2'
+        hash['/path_to/file3.rb'].last[:type].should eq 'type3'
+      end
+    end
+  end
+end

data/spec/unit/tailor/reporter_spec.rb

@@ -43,11 +43,30 @@ describe Tailor::Reporter do
       t
     end
 
-    it "calls #file_report on each @formatters" do
-      label = :some_label
-      formatter.should_receive(:summary_report).with(all_problems)
+    context "without output file" do
+      it "calls #file_report on each @formatters" do
+        label = :some_label
+        formatter.should_receive(:summary_report).with(all_problems)
+        File.should_not_receive(:open)
+
+        subject.summary_report(all_problems)
+      end
+    end
 
-      subject.summary_report(all_problems)
+    context "with output file" do
+      let(:output_file) { "output.whatever" }
+      before do
+        formatter.should_receive(:respond_to?).with(:accepts_output_file).and_return(true)
+        formatter.should_receive(:accepts_output_file).and_return(true)
+      end
+
+      it "calls #summary_report on each @formatters" do
+        formatter.should_receive(:summary_report).with(all_problems)
+        File.should_receive(:open).with(output_file, "w")
+
+        subject.summary_report(all_problems, output_file: output_file)
+      end
     end
+
   end
 end