tailor 1.1.1 → 1.1.2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    tailor (1.1.1)
+    tailor (1.1.2)
       log_switch (>= 0.3.0)
       term-ansicolor (>= 1.0.5)
       text-table (>= 1.2.2)

data/History.rdoc

@@ -1,3 +1,17 @@
+=== 1.1.2 2012-06-01
+
+* gh-101[https://github.com/turboladen/tailor/issues/101]
+  * Tailor now handles code that uses backslashes to break up statements to
+    multiple lines.  Note that this is somewhat of a hack, since Ripper does not
+    tokenize these backslashes--it actually just treats what we see as 2 lines
+    of code as a single line of code.  In order to preserve line numbering and
+    indentation tracking, tailor replaces the backslash with a special comment
+    that it can detect and handle accordingly.  While this isn't ideal, given
+    the current design, it seemed like the way to deal with this.
+* gh-103[https://github.com/turboladen/tailor/issues/103]
+  * Tailor now properly handles string interpolation inside string
+    interpolation.
+  
 === 1.1.1 2012-05-31
 
 * gh-110[https://github.com/turboladen/tailor/issues/110]
@@ -39,8 +53,8 @@
 
 === 1.0.1 2012-04-23
 
-* gh-104: Fixed incorrect rendering of config file when using
-  `tailor --create-config`.
+* gh-104[https://github.com/turboladen/tailor/issues/104]:
+  * Fixed incorrect rendering of config file when using `tailor --create-config`.
 
 === 1.0.0 2012-04-17
 

data/lib/tailor/lexer.rb

@@ -28,6 +28,7 @@ class Tailor
       end
 
       @file_text = ensure_trailing_newline(@original_file_text)
+      @file_text = sub_line_ending_backslashes(@file_text)
       super @file_text
       @added_newline = @file_text != @original_file_text
     end
@@ -553,6 +554,18 @@ class Tailor
     #---------------------------------------------------------------------------
     private
 
+    # Used internally as part of the hack to deal with Ripper's lack of dealing
+    # with line-ending backslashes that break up statements.
+    #
+    # @param [String] file_text The file test to check.
+    # @param [String] The altered file text.
+    def sub_line_ending_backslashes(file_text)
+      backslash_replacement = "# TAILOR REMOVED BACKSLASH"
+      file_text.gsub!(/\\\s*\n?$/, backslash_replacement)
+      
+      file_text
+    end
+    
     def log(*args)
       l = begin; lineno; rescue; "<EOF>"; end
       c = begin; column; rescue; "<EOF>"; end

data/lib/tailor/lexer/token.rb

@@ -102,6 +102,11 @@ class Tailor
 
         result
       end
+      
+      # @return [Boolean]
+      def fake_backslash_line_end?
+        self =~ /^# TAILOR REMOVED BACKSLASH\n?$/
+      end
     end
   end
 end

data/lib/tailor/rulers/indentation_spaces_ruler.rb

@@ -25,11 +25,17 @@ class Tailor
           :tstring_end
         )
         @manager = IndentationManager.new(@config)
-        @embexpr_beg = false
+        @embexpr_nesting = []
         @tstring_nesting = []
       end
 
       def comment_update(token, lexed_line, file_text, lineno, column)
+        if token.fake_backslash_line_end?
+          log "Line was altered by tailor to accommodate trailing backslash"
+          @manager.add_indent_reason(:trailing_backslash, :trailing_backslash,
+            lineno)
+        end
+
         # trailing comment?
         if token.ends_with_newline?
           log "Comment ends with newline.  Removing comment..."
@@ -50,14 +56,14 @@ class Tailor
       end
 
       def embexpr_beg_update
-        @embexpr_beg = true
+        @embexpr_nesting << true
       end
 
       # Due to a Ripper bug (depending on which Ruby version you have), this may
       # or may not get triggered.
       # More info: https://bugs.ruby-lang.org/issues/6211
       def embexpr_end_update
-        @embexpr_beg = false
+        @embexpr_nesting.pop
       end
 
       def ignored_nl_update(current_lexed_line, lineno, column)
@@ -167,7 +173,7 @@ class Tailor
       #
       # @return [Boolean]
       def in_embexpr?
-        @embexpr_beg == true
+        !@embexpr_nesting.empty?
       end
 
       def rbrace_update(current_lexed_line, lineno, column)
@@ -175,7 +181,7 @@ class Tailor
           msg = "Got :rbrace and @embexpr_beg is true. "
           msg << " Must be at an @embexpr_end."
           log msg
-          @embexpr_beg = false
+          @embexpr_nesting.pop
           return
         end
 

data/lib/tailor/rulers/indentation_spaces_ruler/indentation_manager.rb

@@ -333,8 +333,7 @@ class Tailor
           return nil if @indent_reasons.empty?
 
           @indent_reasons.reverse.find do |r|
-            !ENCLOSERS.include? r[:event_type] &&
-              r[:event_type] != :on_kw
+            !ENCLOSERS.include?(r[:event_type]) && r[:event_type] != :on_kw
           end
         end
 

data/lib/tailor/version.rb

@@ -1,3 +1,3 @@
 class Tailor
-  VERSION = '1.1.1'
+  VERSION = '1.1.2'
 end

data/spec/functional/horizontal_spacing_spec.rb

@@ -36,24 +36,49 @@ describe "Horizontal Space problem detection" do
   context "line ends with a backslash" do
     let(:file_name) { :line_split_by_backslash }
 
-    let(:contents) do
-      %Q{execute 'myscript' do
-  command \\
-    '/some/really/long/path/that/would/be/over/eighty/chars.sh'
-  only_if { something }
-end}
-    end
-
     before do
       FileUtils.touch file_name.to_s
       File.open(file_name.to_s, 'w') { |f| f.write contents }
     end
 
-    it "is OK" do
-      pending "Fix of gh-101"
+    context "no problems" do
+      let(:contents) do
+        %Q{execute 'myscript' do
+  command \\
+    '/some/line/that/is/not/over/eighty/chars.sh'
+  only_if { something }
+end}
+      end
 
-      critic.check_file(file_name.to_s, style.to_hash)
-      critic.problems.should == { file_name.to_s =>  [] }
+      it "is OK" do
+        critic.check_file(file_name.to_s, style.to_hash)
+        critic.problems.should == { file_name.to_s => [] }
+      end
+    end
+    
+    context "line after backslash is too long" do
+      let(:contents) do
+        %Q{execute 'myscript' do
+  command \\
+    '#{'*' * 75}'
+  only_if { something }
+end}
+      end
+
+      it "is OK" do
+        critic.check_file(file_name.to_s, style.to_hash)
+        critic.problems.should == {
+          file_name.to_s => [
+            {
+              :type => "max_line_length",
+              :line => 3,
+              :column => 81,
+              :message => "Line is 81 chars long, but should be 80.",
+              :level=>:error
+            }
+          ]
+        }
+      end
     end
   end
 end

data/spec/functional/indentation_spacing/bad_indentation_spec.rb

@@ -103,16 +103,14 @@ describe "Detection of method length" do
 
     context "class method outdented, in a class" do
       let(:file_name) { :class_method_def_using_self_outdented }
+      
       specify do
-        pending "Fix of gh-109"
         critic.problems[file_name.to_s].size.should be 1
       end
-=begin
       specify { critic.problems[file_name.to_s].first[:type].should == "indentation_spaces" }
       specify { critic.problems[file_name.to_s].first[:line].should be 2 }
       specify { critic.problems[file_name.to_s].first[:column].should be 1 }
       specify { critic.problems[file_name.to_s].first[:level].should be :error }
-=end
     end
   end
 

data/spec/support/bad_indentation_cases.rb

@@ -47,7 +47,7 @@ end}
 
 INDENT_1[:class_method_def_using_self_outdented] =
   %Q{class A
- self.my_method
+ def self.my_method
     puts 'stuff'
   end
 end}

data/spec/support/good_indentation_cases.rb

@@ -440,6 +440,17 @@ INDENT_OK[:deep_hash_with_rockets] =
         "e" => "E",
         "f" => "F" } } }]
 
+INDENT_OK[:embedded_strings_in_embedded_strings] =
+  %q[def friendly_time(time)
+  if hours < 24
+    "#{(hours > 0) ? "#{hours} hour" : '' }#{(hours > 1) ? 's' : ''}" +
+      " #{(mins > 0) ? "#{mins} minute" : '' }#{(mins > 1) ? 's' : ''}" +
+      " #{seconds} second#{(seconds > 1) ? "s" : ''} ago"
+  else
+    time.to_s
+  end
+end]
+
 #----------- Brackets ----------#
 INDENT_OK[:single_line_brackets] =
   %Q{['one', 'two', 'three']}

data/spec/unit/tailor/lexer_spec.rb

@@ -122,4 +122,22 @@ describe Tailor::Lexer do
       end
     end
   end
+  
+  describe "#sub_line_ending_backslashes" do
+    let!(:text) do
+      %Q{command \\
+  'something'}
+    end
+    
+    before do
+      def subject.sub_publicly(file_text)
+        sub_line_ending_backslashes(file_text)
+      end
+    end
+    
+    it "replaces all line-ending backslashes with a comment" do
+      subject.sub_publicly(text).should == %Q{command # TAILOR REMOVED BACKSLASH
+  'something'}
+    end
+  end
 end

data/spec/unit/tailor/rulers/indentation_spaces_ruler_spec.rb

@@ -35,19 +35,18 @@ describe Tailor::Rulers::IndentationSpacesRuler do
   end
 
   describe "#embexpr_beg_update" do
-    it "sets @embexpr_beg to true" do
-      subject.instance_variable_set(:@embexpr_beg, false)
+    it "sets @embexpr_nesting to [true]" do
+      subject.instance_variable_set(:@embexpr_nesting, [])
       subject.embexpr_beg_update
-      subject.instance_variable_get(:@embexpr_beg).should be_true
+      subject.instance_variable_get(:@embexpr_nesting).should == [true]
     end
   end
 
-
   describe "#embexpr_end_update" do
-    it "sets @embexpr_beg to false" do
-      subject.instance_variable_set(:@embexpr_beg, true)
+    it "pops @embexpr_nesting" do
+      subject.instance_variable_set(:@embexpr_nesting, [true])
       subject.embexpr_end_update
-      subject.instance_variable_get(:@embexpr_beg).should be_false
+      subject.instance_variable_get(:@embexpr_nesting).should == []
     end
   end
 

data/spec/unit/tailor/version_spec.rb

@@ -2,5 +2,5 @@ require_relative '../../spec_helper'
 require 'tailor/version'
 
 describe Tailor::VERSION do
-  it { should == "1.1.1" }
+  it { should == "1.1.2" }
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tailor
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-31 00:00:00.000000000 Z
+date: 2012-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: log_switch