tailor 1.0.0.alpha2 → 1.0.0

data/spec/tailor/critic_spec.rb

@@ -2,13 +2,12 @@ require_relative '../spec_helper'
 require 'tailor/critic'
 
 describe Tailor::Critic do
-  let(:configuration) { } # empty on purpose
-  before { subject.stub(:log) }
-  subject { Tailor::Critic.new(configuration) }
+  before { Tailor::Logger.stub(:log) }
 
   describe "#check_file" do
     let(:lexer) { double "Lexer" }
     let(:ruler) { double "Ruler" }
+    let(:style) { double "Style", each: nil }
     let(:file_name) { "this_file.rb" }
 
     before do
@@ -22,7 +21,7 @@ describe Tailor::Critic do
       subject.stub_chain(:problems, :[]=)
       subject.stub_chain(:problems, :[])
 
-      subject.check_file(file_name, 1)
+      subject.check_file(file_name, style)
     end
 
     it "adds problems for the file to the main list of problems" do
@@ -31,7 +30,7 @@ describe Tailor::Critic do
       Tailor::Lexer.stub(:new).and_return lexer
       subject.problems.should_receive(:[]=).with(file_name, [])
 
-      subject.check_file(file_name, 1)
+      subject.check_file(file_name, style)
     end
   end
 
@@ -51,9 +50,9 @@ describe Tailor::Critic do
     context "#problems contains valid values" do
       it "adds the number of each problem together" do
         probs = {
-           one: { type: :indentation, line: 1, message: "" },
-           two: { type: :indentation, line: 2, message: "" },
-           thre: { type: :indentation, line: 27, message: "" }
+          one: { type: :indentation, line: 1, message: "" },
+          two: { type: :indentation, line: 2, message: "" },
+          thre: { type: :indentation, line: 27, message: "" }
         }
         subject.instance_variable_set(:@problems, probs)
         subject.problem_count.should == 3

data/spec/tailor/formatter_spec.rb

@@ -0,0 +1,52 @@
+require_relative '../spec_helper'
+require 'tailor/formatter'
+
+describe Tailor::Formatter do
+  describe "#problems_at_level" do
+    let(:problems) do
+      msg = "File contains invalid Ruby; "
+      msg << "run `ruby -c [your_file.rb]` for more details."
+
+      {
+        "some_file.rb" => [
+          {
+            :type => "allow_invalid_ruby",
+            :line => 0,
+            :column => 0,
+            :message => msg,
+            :level => :warn
+          }
+        ]
+      }
+    end
+
+    context "problems are empty" do
+      it "returns an empty Array" do
+        subject.problems_at_level({}, :error).should == []
+      end
+    end
+
+    context "the level asked for exists in the problems" do
+      it "returns the problem" do
+        msg = "File contains invalid Ruby; "
+        msg << "run `ruby -c [your_file.rb]` for more details."
+
+        subject.problems_at_level(problems, :warn).should == [
+          {
+            :type => "allow_invalid_ruby",
+            :line => 0,
+            :column => 0,
+            :message => msg,
+            :level => :warn
+          }
+        ]
+      end
+    end
+
+    context "the level asked for does not exist in the problems" do
+      it "returns an empty Array" do
+        subject.problems_at_level(problems, :error).should == []
+      end
+    end
+  end
+end

data/spec/tailor/lexed_line_spec.rb

@@ -12,17 +12,17 @@ describe Tailor::LexedLine do
     let(:lexed_output) do
       [
         [[1, 0], :on_ident, "require"],
-          [[1, 7], :on_sp, " "],
-          [[1, 8], :on_tstring_beg, "'"],
-          [[1, 9], :on_tstring_content, "log_switch"],
-          [[1, 19], :on_tstring_end, "'"],
-          [[1, 20], :on_nl, "\n"],
-          [[2, 0], :on_ident, "require_relative"],
-          [[2, 16], :on_sp, " "],
-          [[2, 17], :on_tstring_beg, "'"],
-          [[2, 18], :on_tstring_content, "tailor/runtime_error"],
-          [[2, 38], :on_tstring_end, "'"],
-          [[2, 39], :on_nl, "\n"]
+        [[1, 7], :on_sp, " "],
+        [[1, 8], :on_tstring_beg, "'"],
+        [[1, 9], :on_tstring_content, "log_switch"],
+        [[1, 19], :on_tstring_end, "'"],
+        [[1, 20], :on_nl, "\n"],
+        [[2, 0], :on_ident, "require_relative"],
+        [[2, 16], :on_sp, " "],
+        [[2, 17], :on_tstring_beg, "'"],
+        [[2, 18], :on_tstring_content, "tailor/runtime_error"],
+        [[2, 38], :on_tstring_end, "'"],
+        [[2, 39], :on_nl, "\n"]
       ]
     end
 
@@ -140,11 +140,11 @@ describe Tailor::LexedLine do
       let(:lexed_output) do
         [
           [[1, 0], :on_ident, "thing"],
-            [[1, 5], :on_sp, " "],
-            [[1, 6], :on_op, "="],
-            [[1, 7], :on_sp, " "],
-            [[1, 8], :on_int, "1"],
-            [[1, 9], :on_ignored_nl, "\n"]
+          [[1, 5], :on_sp, " "],
+          [[1, 6], :on_op, "="],
+          [[1, 7], :on_sp, " "],
+          [[1, 8], :on_int, "1"],
+          [[1, 9], :on_ignored_nl, "\n"]
         ]
       end
 
@@ -159,13 +159,13 @@ describe Tailor::LexedLine do
       let(:lexed_output) do
         [
           [[1, 0], :on_ident, "thing"],
-            [[1, 5], :on_sp, " "],
-            [[1, 6], :on_op, "="],
-            [[1, 7], :on_sp, " "],
-            [[1, 8], :on_int, "1"],
-            [[1, 9], :on_sp, " "],
-            [[1, 10], :on_kw, "if"],
-            [[1, 12], :on_ignored_nl, "\n"]
+          [[1, 5], :on_sp, " "],
+          [[1, 6], :on_op, "="],
+          [[1, 7], :on_sp, " "],
+          [[1, 8], :on_int, "1"],
+          [[1, 9], :on_sp, " "],
+          [[1, 10], :on_kw, "if"],
+          [[1, 12], :on_ignored_nl, "\n"]
         ]
       end
 
@@ -205,10 +205,10 @@ describe Tailor::LexedLine do
     let(:lexed_output) do
       [
         [[1, 0], :on_kw, "def"],
-          [[1, 3], :on_sp, " "],
-          [[1, 4], :on_ident, "thing"],
-          [[1, 9], :on_sp, " "],
-          [[1, 10], :on_nl, "\n"]
+        [[1, 3], :on_sp, " "],
+        [[1, 4], :on_ident, "thing"],
+        [[1, 9], :on_sp, " "],
+        [[1, 10], :on_nl, "\n"]
       ]
     end
 
@@ -225,10 +225,50 @@ describe Tailor::LexedLine do
     end
   end
 
+  describe "#last_non_line_feed_event" do
+    context "line ends with a space" do
+      let(:lexed_output) do
+        [
+          [[1, 0], :on_kw, "def"],
+          [[1, 3], :on_sp, " "],
+          [[1, 4], :on_ident, "thing"],
+          [[1, 9], :on_sp, " "],
+          [[1, 10], :on_nl, "\n"]
+        ]
+      end
+
+      it "returns the space" do
+        subject.last_non_line_feed_event.should == [[1, 9], :on_sp, " "]
+      end
+    end
+
+    context "line ends with a backslash" do
+      let(:lexed_output) do
+        [
+          [[1, 0], :on_kw, "def"],
+          [[1, 3], :on_sp, " "],
+          [[1, 4], :on_ident, "thing"],
+          [[1, 9], :on_sp, "\\\n"]
+        ]
+      end
+
+      it "returns the event before it" do
+        subject.last_non_line_feed_event.should == [[1, 4], :on_ident, "thing"]
+      end
+    end
+  end
+
   describe "#loop_with_do?" do
     context "line is 'while true do\\n'" do
       let(:lexed_output) do
-        [[[1, 0], :on_kw, "while"], [[1, 5], :on_sp, " "], [[1, 6], :on_kw, "true"], [[1, 10], :on_sp, " "], [[1, 11], :on_kw, "do"], [[1, 13], :on_ignored_nl, "\n"]]
+        [
+          [[1, 0], :on_kw, "while"],
+          [[1, 5], :on_sp, " "],
+          [[1, 6], :on_kw, "true"],
+          [[1, 10], :on_sp, " "],
+          [[1, 11], :on_kw, "do"],
+          [[1, 13], :on_ignored_nl, "\n"]
+        ]
       end
 
       it "returns true" do
@@ -238,7 +278,13 @@ describe Tailor::LexedLine do
 
     context "line is 'while true\\n'" do
       let(:lexed_output) do
-        [[[1, 0], :on_kw, "while"], [[1, 5], :on_sp, " "], [[1, 6], :on_kw, "true"], [[1, 10], :on_sp, " "], [[1, 11], :on_ignored_nl, "\n"]]
+        [
+          [[1, 0], :on_kw, "while"],
+          [[1, 5], :on_sp, " "],
+          [[1, 6], :on_kw, "true"],
+          [[1, 10], :on_sp, " "],
+          [[1, 11], :on_ignored_nl, "\n"]
+        ]
       end
 
       it "returns false" do
@@ -248,7 +294,14 @@ describe Tailor::LexedLine do
 
     context "line is 'until true do\\n'" do
       let(:lexed_output) do
-        [[[1, 0], :on_kw, "until"], [[1, 5], :on_sp, " "], [[1, 6], :on_kw, "true"], [[1, 10], :on_sp, " "], [[1, 11], :on_kw, "do"], [[1, 13], :on_ignored_nl, "\n"]]
+        [
+          [[1, 0], :on_kw, "until"],
+          [[1, 5], :on_sp, " "],
+          [[1, 6], :on_kw, "true"],
+          [[1, 10], :on_sp, " "],
+          [[1, 11], :on_kw, "do"],
+          [[1, 13], :on_ignored_nl, "\n"]
+        ]
       end
 
       it "returns true" do
@@ -258,7 +311,13 @@ describe Tailor::LexedLine do
 
     context "line is 'until true\\n'" do
       let(:lexed_output) do
-        [[[1, 0], :on_kw, "until"], [[1, 5], :on_sp, " "], [[1, 6], :on_kw, "true"], [[1, 10], :on_sp, " "], [[1, 11], :on_ignored_nl, "\n"]]
+        [
+          [[1, 0], :on_kw, "until"],
+          [[1, 5], :on_sp, " "],
+          [[1, 6], :on_kw, "true"],
+          [[1, 10], :on_sp, " "],
+          [[1, 11], :on_ignored_nl, "\n"]
+        ]
       end
 
       it "returns false" do
@@ -268,7 +327,20 @@ describe Tailor::LexedLine do
 
     context "line is 'for i in 1..5 do\\n'" do
       let(:lexed_output) do
-        [[[1, 0], :on_kw, "for"], [[1, 3], :on_sp, " "], [[1, 4], :on_ident, "i"], [[1, 5], :on_sp, " "], [[1, 6], :on_kw, "in"], [[1, 8], :on_sp, " "], [[1, 9], :on_int, "1"], [[1, 10], :on_op, ".."], [[1, 12], :on_int, "5"], [[1, 13], :on_sp, " "], [[1, 14], :on_kw, "do"], [[1, 16], :on_ignored_nl, "\n"]]
+        [
+          [[1, 0], :on_kw, "for"],
+          [[1, 3], :on_sp, " "],
+          [[1, 4], :on_ident, "i"],
+          [[1, 5], :on_sp, " "],
+          [[1, 6], :on_kw, "in"],
+          [[1, 8], :on_sp, " "],
+          [[1, 9], :on_int, "1"],
+          [[1, 10], :on_op, ".."],
+          [[1, 12], :on_int, "5"],
+          [[1, 13], :on_sp, " "],
+          [[1, 14], :on_kw, "do"],
+          [[1, 16], :on_ignored_nl, "\n"]
+        ]
       end
 
       it "returns true" do
@@ -278,7 +350,19 @@ describe Tailor::LexedLine do
 
     context "line is 'for i in 1..5\\n'" do
       let(:lexed_output) do
-        [[[1, 0], :on_kw, "for"], [[1, 3], :on_sp, " "], [[1, 4], :on_ident, "i"], [[1, 5], :on_sp, " "], [[1, 6], :on_kw, "in"], [[1, 8], :on_sp, " "], [[1, 9], :on_int, "1"], [[1, 10], :on_op, ".."], [[1, 12], :on_int, "5"], [[1, 13], :on_sp, " "], [[1, 14], :on_ignored_nl, "\n"]]
+        [
+          [[1, 0], :on_kw, "for"],
+          [[1, 3], :on_sp, " "],
+          [[1, 4], :on_ident, "i"],
+          [[1, 5], :on_sp, " "],
+          [[1, 6], :on_kw, "in"],
+          [[1, 8], :on_sp, " "],
+          [[1, 9], :on_int, "1"],
+          [[1, 10], :on_op, ".."],
+          [[1, 12], :on_int, "5"],
+          [[1, 13], :on_sp, " "],
+          [[1, 14], :on_ignored_nl, "\n"]
+        ]
       end
 
       it "returns false" do
@@ -305,7 +389,13 @@ describe Tailor::LexedLine do
     end
 
     context "lexed line contains '  }\\n'" do
-      let(:lexed_output) { [[[1, 0], :on_sp, "  "], [[1, 2], :on_rbrace, "}"], [[1, 3], :on_nl, "\n"]] }
+      let(:lexed_output) do
+        [
+          [[1, 0], :on_sp, "  "],
+          [[1, 2], :on_rbrace, "}"],
+          [[1, 3], :on_nl, "\n"]
+        ]
+      end
 
       it "returns nil" do
         subject.first_non_space_element.should == [[1, 2], :on_rbrace, "}"]
@@ -348,10 +438,10 @@ describe Tailor::LexedLine do
     let(:lexed_output) do
       [
         [[1, 0], :on_kw, "def"],
-          [[1, 3], :on_sp, " "],
-          [[1, 4], :on_ident, "thing"],
-          [[1, 9], :on_sp, " "],
-          [[1, 10], :on_nl, "\n"]
+        [[1, 3], :on_sp, " "],
+        [[1, 4], :on_ident, "thing"],
+        [[1, 9], :on_sp, " "],
+        [[1, 10], :on_nl, "\n"]
       ]
     end
 
@@ -366,13 +456,13 @@ describe Tailor::LexedLine do
         let(:lexed_output) do
           [
             [[1, 0], :on_kw, "def"],
-              [[1, 3], :on_sp, " "],
-              [[1, 4], :on_ident, "thing"],
-              [[1, 9], :on_sp, " "],
-              [[1, 10], :on_ident, "one"],
-              [[1, 13], :on_comma, ","],
-              [[1, 14], :on_sp, "  "],
-              [[1, 16], :on_comment, "# comment\n"]
+            [[1, 3], :on_sp, " "],
+            [[1, 4], :on_ident, "thing"],
+            [[1, 9], :on_sp, " "],
+            [[1, 10], :on_ident, "one"],
+            [[1, 13], :on_comma, ","],
+            [[1, 14], :on_sp, "  "],
+            [[1, 16], :on_comment, "# comment\n"]
           ]
         end
 
@@ -383,26 +473,26 @@ describe Tailor::LexedLine do
         it "replaces the comment with an :on_ignored_nl" do
           subject.remove_trailing_comment(file_text).should == [
             [[1, 0], :on_kw, "def"],
-              [[1, 3], :on_sp, " "],
-              [[1, 4], :on_ident, "thing"],
-              [[1, 9], :on_sp, " "],
-              [[1, 10], :on_ident, "one"],
-              [[1, 13], :on_comma, ","],
-              [[1, 14], :on_ignored_nl, "\n"]
+            [[1, 3], :on_sp, " "],
+            [[1, 4], :on_ident, "thing"],
+            [[1, 9], :on_sp, " "],
+            [[1, 10], :on_ident, "one"],
+            [[1, 13], :on_comma, ","],
+            [[1, 14], :on_ignored_nl, "\n"]
           ]
         end
       end
-      
+
       context "no spaces before comment" do
         let(:lexed_output) do
           [
             [[1, 0], :on_kw, "def"],
-              [[1, 3], :on_sp, " "],
-              [[1, 4], :on_ident, "thing"],
-              [[1, 9], :on_sp, " "],
-              [[1, 10], :on_ident, "one"],
-              [[1, 13], :on_comma, ","],
-              [[1, 14], :on_comment, "# comment\n"]
+            [[1, 3], :on_sp, " "],
+            [[1, 4], :on_ident, "thing"],
+            [[1, 9], :on_sp, " "],
+            [[1, 10], :on_ident, "one"],
+            [[1, 13], :on_comma, ","],
+            [[1, 14], :on_comment, "# comment\n"]
           ]
         end
 
@@ -413,28 +503,28 @@ describe Tailor::LexedLine do
         it "replaces the comment with an :on_ignored_nl" do
           subject.remove_trailing_comment(file_text).should == [
             [[1, 0], :on_kw, "def"],
-              [[1, 3], :on_sp, " "],
-              [[1, 4], :on_ident, "thing"],
-              [[1, 9], :on_sp, " "],
-              [[1, 10], :on_ident, "one"],
-              [[1, 13], :on_comma, ","],
-              [[1, 14], :on_ignored_nl, "\n"]
+            [[1, 3], :on_sp, " "],
+            [[1, 4], :on_ident, "thing"],
+            [[1, 9], :on_sp, " "],
+            [[1, 10], :on_ident, "one"],
+            [[1, 13], :on_comma, ","],
+            [[1, 14], :on_ignored_nl, "\n"]
           ]
         end
       end
     end
-    
+
     context "stuff before comment is a complete statement" do
       context "spaces before comment" do
         let(:lexed_output) do
           [
             [[1, 0], :on_kw, "def"],
-              [[1, 3], :on_sp, " "],
-              [[1, 4], :on_ident, "thing"],
-              [[1, 9], :on_sp, " "],
-              [[1, 10], :on_ident, "one"],
-              [[1, 13], :on_sp, "  "],
-              [[1, 15], :on_comment, "# comment\n"]
+            [[1, 3], :on_sp, " "],
+            [[1, 4], :on_ident, "thing"],
+            [[1, 9], :on_sp, " "],
+            [[1, 10], :on_ident, "one"],
+            [[1, 13], :on_sp, "  "],
+            [[1, 15], :on_comment, "# comment\n"]
           ]
         end
 
@@ -445,11 +535,11 @@ describe Tailor::LexedLine do
         it "replaces the comment with an :on_nl" do
           subject.remove_trailing_comment(file_text).should == [
             [[1, 0], :on_kw, "def"],
-              [[1, 3], :on_sp, " "],
-              [[1, 4], :on_ident, "thing"],
-              [[1, 9], :on_sp, " "],
-              [[1, 10], :on_ident, "one"],
-              [[1, 13], :on_nl, "\n"]
+            [[1, 3], :on_sp, " "],
+            [[1, 4], :on_ident, "thing"],
+            [[1, 9], :on_sp, " "],
+            [[1, 10], :on_ident, "one"],
+            [[1, 13], :on_nl, "\n"]
           ]
         end
       end
@@ -458,11 +548,11 @@ describe Tailor::LexedLine do
         let(:lexed_output) do
           [
             [[1, 0], :on_kw, "def"],
-              [[1, 3], :on_sp, " "],
-              [[1, 4], :on_ident, "thing"],
-              [[1, 9], :on_sp, " "],
-              [[1, 10], :on_ident, "one"],
-              [[1, 13], :on_comment, "# comment\n"]
+            [[1, 3], :on_sp, " "],
+            [[1, 4], :on_ident, "thing"],
+            [[1, 9], :on_sp, " "],
+            [[1, 10], :on_ident, "one"],
+            [[1, 13], :on_comment, "# comment\n"]
           ]
         end
 
@@ -473,16 +563,17 @@ describe Tailor::LexedLine do
         it "replaces the comment with an :on_nl" do
           subject.remove_trailing_comment(file_text).should == [
             [[1, 0], :on_kw, "def"],
-              [[1, 3], :on_sp, " "],
-              [[1, 4], :on_ident, "thing"],
-              [[1, 9], :on_sp, " "],
-              [[1, 10], :on_ident, "one"],
-              [[1, 13], :on_nl, "\n"]
+            [[1, 3], :on_sp, " "],
+            [[1, 4], :on_ident, "thing"],
+            [[1, 9], :on_sp, " "],
+            [[1, 10], :on_ident, "one"],
+            [[1, 13], :on_nl, "\n"]
           ]
         end
-        
+
         it "returns a LexedLine" do
-          subject.remove_trailing_comment(file_text).should be_a Tailor::LexedLine
+          subject.remove_trailing_comment(file_text).
+            should be_a Tailor::LexedLine
         end
       end
     end
@@ -566,4 +657,61 @@ describe Tailor::LexedLine do
       end
     end
   end
+
+  describe "#keyword_is_symbol?" do
+    context "last event in line is not a keyword" do
+      let(:lexed_output) do
+        [
+          [[1, 0], :on_sp, "        "],
+          [[1, 8], :on_ident, "one"],
+          [[1, 11], :on_comma, ","],
+          [[1, 12], :on_nl, "\n"]]
+      end
+
+      it "returns false" do
+        subject.keyword_is_symbol?.should be_false
+      end
+    end
+
+    context "last event in line is a keyword" do
+      context "previous event is nil" do
+        let(:lexed_output) do
+          [
+            [[1, 0], :on_kw, "class"]
+          ]
+        end
+
+        it "returns false" do
+          subject.keyword_is_symbol?.should be_false
+        end
+      end
+
+      context "previous event is not :on_symbeg" do
+        let(:lexed_output) do
+          [
+            [[1, 0], :on_sp, "  "],
+            [[1, 2], :on_kw, "class"]
+          ]
+        end
+
+        it "returns false" do
+          subject.keyword_is_symbol?.should be_false
+        end
+      end
+
+      context "previous event is :on_symbeg" do
+        let(:lexed_output) do
+          [
+            [[1, 0], :on_const, "INDENT_OK"],
+            [[1, 9], :on_lbracket, "["],
+            [[1, 10], :on_symbeg, ":"],
+            [[1, 11], :on_kw, "class"]]
+        end
+
+        it "returns true" do
+          subject.keyword_is_symbol?.should be_true
+        end
+      end
+    end
+  end
 end