transpec 2.3.4 → 2.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 86662f1a0e4d74de2c72d36a51b77e8a64b28636
-  data.tar.gz: a6fda615ce95a0808a127d6bf9412665accc3b7d
+  metadata.gz: a673a8ed54eae74d68ffe6c597ee95b5a2bbc1d9
+  data.tar.gz: 840daba419607526564f7b5375268a56e811993b
 SHA512:
-  metadata.gz: 062e9dcef16a3c208fef5fdc439b0e9a1fec8b99eb43dd32a6afc9f2a446c2c9e45f89472728686515e194ebecf3709b505c939edf68454c65dae01f63be81d4
-  data.tar.gz: e153260bbd9c687c0281a37eb82b8e6b376fa2961601580186bf26074957fa2948e30f6ea3acbf9bf2cad415af33aacdc675f27b3bb678f182a466ce0c3e1789
+  metadata.gz: 851f291d709b03c6dc94610aee361813967280d3da164fcbc0e21ab525bde5f941322aa4c6c85d926806bde439f3508b00d2b8b860bdc70233e2b3c090e977d9
+  data.tar.gz: d0dd0b1cc61f6f31ee6dfc78bbf4adc01866f500d0cb854c209e5c1cff7177ca256227361247bb18a7480f745026dd54b15dfde676eb779ce7ba8302d866ce9c

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Development
 
+## v2.3.5
+
+* Avoid crash on processing invalid encoding source files and warn of the encoding errors. ([#81](https://github.com/yujinakayama/transpec/issues/81))
+
 ## v2.3.4
 
 * Detect whether RSpec configuration `config.raise_errors_for_deprecations!` which interferes with Transpec's dynamic analysis is enabled in the user's specs and abort processing if so. ([#80](https://github.com/yujinakayama/transpec/issues/80))

data/lib/transpec/base_rewriter.rb

@@ -6,7 +6,7 @@ module Transpec
   class BaseRewriter
     def rewrite_file!(arg)
       processed_source = case arg
-                         when String          then ProcessedSource.parse_file(arg)
+                         when String          then ProcessedSource.from_file(arg)
                          when ProcessedSource then arg
                          else fail "Invalid argument: #{arg}"
                          end
@@ -19,12 +19,12 @@ module Transpec
     end
 
     def rewrite_source(source, path = nil)
-      processed_source = ProcessedSource.parse(source, path)
+      processed_source = ProcessedSource.new(source, path)
       rewrite(processed_source)
     end
 
     def rewrite(processed_source)
-      fail processed_source.syntax_error if processed_source.syntax_error
+      fail processed_source.error if processed_source.error
 
       source_rewriter = create_source_rewriter(processed_source)
       incomplete = false

data/lib/transpec/cli.rb

@@ -90,9 +90,9 @@ module Transpec
 
       warn_annotations(converter.report)
       report << converter.report
-    rescue Parser::SyntaxError => error
-      report.syntax_errors << error
-      warn_syntax_error(error)
+    rescue Parser::SyntaxError, EncodingError => error
+      warn_file_error(error, spec.path)
+      report.file_errors << error
     end
 
     private
@@ -145,8 +145,18 @@ module Transpec
       puts "Done! Now run #{'rspec'.bright} and check if everything is green."
     end
 
-    def warn_syntax_error(error)
-      warn "Syntax error at #{error.diagnostic.location}. Skipping the file.".color(:red)
+    def warn_file_error(error, path)
+      message = case error
+                when Parser::SyntaxError
+                  "Syntax error at #{error.diagnostic.location}."
+                when EncodingError
+                  "Encoding error in #{path}."
+                else
+                  "#{error.message.capitalize} in #{path}."
+                end
+
+      message << ' Skipping the file.'
+      warn message.color(:red)
     end
 
     def warn_annotations(report)

data/lib/transpec/dynamic_analyzer.rb

@@ -84,7 +84,7 @@ module Transpec
       spec_suite = SpecSuite.new(paths)
 
       spec_suite.specs.each do |spec|
-        next if spec.syntax_error
+        next if spec.error
         rewriter.rewrite_file!(spec)
       end
     end

data/lib/transpec/processed_source.rb

@@ -12,37 +12,34 @@ require 'transpec/ast/builder'
 
 module Transpec
   class ProcessedSource
-    attr_reader :buffer, :ast, :path, :syntax_error
+    attr_reader :buffer, :ast, :path, :error
 
-    def self.parse_file(path)
+    def self.from_file(path)
       source = File.read(path)
-      parse(source, path)
+      new(source, path)
     end
 
-    def self.parse(source, path = nil)
-      buffer = Parser::Source::Buffer.new(path || '(string)')
-      buffer.source = source
-
-      builder = AST::Builder.new
-      parser = Parser::CurrentRuby.new(builder)
-
-      begin
-        ast = parser.parse(buffer)
-        new(buffer, ast, path)
-      rescue Parser::SyntaxError => error
-        new(buffer, nil, path, error)
-      end
-    end
-
-    def initialize(buffer, ast, path = nil, syntax_error = nil)
-      @buffer = buffer
-      @ast = ast
+    def initialize(source, path = nil)
       @path = path
-      @syntax_error = syntax_error
+      parse(source)
     end
 
     def to_s
       buffer.source
     end
+
+    private
+
+    def parse(source)
+      @buffer = Parser::Source::Buffer.new(@path || '(string)')
+      @buffer.source = source
+
+      builder = AST::Builder.new
+      parser = Parser::CurrentRuby.new(builder)
+
+      @ast = parser.parse(@buffer)
+    rescue Parser::SyntaxError, EncodingError => error
+      @error = error
+    end
   end
 end

data/lib/transpec/report.rb

@@ -4,18 +4,18 @@ require 'rainbow'
 
 module Transpec
   class Report
-    attr_reader :records, :conversion_errors, :syntax_errors
+    attr_reader :records, :conversion_errors, :file_errors
 
     def initialize
       @records = []
       @conversion_errors = []
-      @syntax_errors = []
+      @file_errors = []
     end
 
     def <<(other)
       records.concat(other.records)
       conversion_errors.concat(other.conversion_errors)
-      syntax_errors.concat(other.syntax_errors)
+      file_errors.concat(other.file_errors)
       self
     end
 
@@ -113,13 +113,13 @@ module Transpec
     end
 
     def error_stats(base_color)
-      color = if syntax_errors.empty?
+      color = if file_errors.empty?
                 base_color
               else
                 :red
               end
 
-      colorize(pluralize(syntax_errors.count, 'error'), color)
+      colorize(pluralize(file_errors.count, 'error'), color)
     end
 
     def pluralize(number, thing, options = {})

data/lib/transpec/spec_suite.rb

@@ -20,7 +20,7 @@ module Transpec
 
     def specs
       @specs ||= FileFinder.find(@base_paths).map do |path|
-        ProcessedSource.parse_file(path)
+        ProcessedSource.from_file(path)
       end
     end
 

data/lib/transpec/version.rb

@@ -5,7 +5,7 @@ module Transpec
   module Version
     MAJOR = 2
     MINOR = 3
-    PATCH = 4
+    PATCH = 5
 
     def self.to_s
       [MAJOR, MINOR, PATCH].join('.')

data/spec/support/shared_context.rb

@@ -6,7 +6,7 @@ shared_context 'parsed objects' do
 
   let(:processed_source) do
     require 'transpec/processed_source'
-    Transpec::ProcessedSource.parse(source, source_path)
+    Transpec::ProcessedSource.new(source, source_path)
   end
 
   let(:ast) do

data/spec/transpec/cli_spec.rb

@@ -139,7 +139,7 @@ module Transpec
 
         include_examples 'aborts processing'
 
-        it 'warns to the user' do
+        it 'warns to the version' do
           cli.should_receive(:warn).with(/rspec.+dependency/i)
           cli.run(args)
         end
@@ -176,6 +176,33 @@ module Transpec
         end
       end
 
+      context 'when an encoding error is raised while processing files' do
+        let(:args) { [invalid_encoding_file_path, valid_encoding_file_path] }
+        let(:invalid_encoding_file_path) { 'spec/invalid_example.rb' }
+        let(:valid_encoding_file_path) { 'spec/valid_example.rb' }
+
+        before do
+          create_file(invalid_encoding_file_path, <<-END)
+            # coding: utf-8
+            \xff
+          END
+
+          create_file(valid_encoding_file_path, 'this_is_valid_encoding')
+        end
+
+        it 'warns of the error' do
+          cli.should_receive(:warn)
+            .with('Encoding error in spec/invalid_example.rb. Skipping the file.')
+          cli.run(args)
+        end
+
+        it 'continues processing files' do
+          cli.should_receive(:puts).with("Converting #{invalid_encoding_file_path}")
+          cli.should_receive(:puts).with("Converting #{valid_encoding_file_path}")
+          cli.run(args)
+        end
+      end
+
       context 'when any other error is raised while running' do
         let(:args) { ['non-existent-file'] }
 
@@ -215,7 +242,7 @@ module Transpec
       let(:processed_source) do
         path = 'example.rb'
         create_file(path, source)
-        ProcessedSource.parse_file(path)
+        ProcessedSource.from_file(path)
       end
 
       let(:spec_suite) { SpecSuite.new }
@@ -241,7 +268,7 @@ module Transpec
           END
         end
 
-        it 'warns to user' do
+        it 'warns of the conversion error' do
           cli.should_receive(:warn) do |message|
             message.should =~ /cannot/i
             message.should =~ /context/i
@@ -262,7 +289,7 @@ module Transpec
           END
         end
 
-        it 'warns to user' do
+        it 'warns of less accurate conversion' do
           cli.should_receive(:warn).with(/converted.+but.+incorrect/i)
           cli.convert_spec(processed_source, spec_suite)
         end

data/spec/transpec/converter_spec.rb

@@ -29,7 +29,7 @@ module Transpec
       end
 
       context 'when a processed source is passed' do
-        let(:processed_source) { ProcessedSource.parse_file(file_path) }
+        let(:processed_source) { ProcessedSource.from_file(file_path) }
 
         it 'overwrites the file that the processed source was derived from' do
           converter.convert_file!(processed_source)

data/spec/transpec/dynamic_analyzer_spec.rb

@@ -10,7 +10,7 @@ module Transpec
     include_context 'isolated environment'
 
     def find_node_in_file(file_path, &block)
-      processed_source = ProcessedSource.parse_file(file_path)
+      processed_source = ProcessedSource.from_file(file_path)
       processed_source.ast.each_node.find(&block)
     end
 

data/spec/transpec/processed_source_spec.rb

@@ -16,38 +16,64 @@ module Transpec
       end
 
       it 'parses the file and returns processed source' do
-        processed_source = ProcessedSource.parse_file(spec_path)
+        processed_source = ProcessedSource.from_file(spec_path)
         processed_source.path.should == spec_path
         processed_source.ast.should_not be_nil
       end
     end
 
-    describe '.parse' do
-      it 'parses the source and returns processed source' do
-        processed_source = ProcessedSource.parse("puts 'foo'")
-        processed_source.ast.should_not be_nil
+    subject(:processed_source) { ProcessedSource.new(source) }
+
+    describe '#ast' do
+      let(:source) { "puts 'foo'" }
+
+      it 'returns the root node of AST' do
+        processed_source.ast.should be_a(Parser::AST::Node)
       end
+    end
 
-      context 'when a file path is passed' do
-        let(:spec_path) { 'spec/example_spec.rb' }
+    describe '#path' do
+      let(:source) { "puts 'foo'" }
 
-        it 'sets the path to the instance' do
-          processed_source = ProcessedSource.parse("puts 'foo'", spec_path)
-          processed_source.path.should == spec_path
+      context 'when a file path is passed to .new' do
+        subject(:processed_source) { ProcessedSource.new(source, '/path/to/file') }
+
+        it 'returns the path' do
+          processed_source.path.should == '/path/to/file'
         end
       end
 
-      context 'when no file path is passed' do
-        it 'does not set the path to the instance' do
-          processed_source = ProcessedSource.parse("puts 'foo'")
+      context 'when no file path is passed to .new' do
+        it 'returns nil' do
           processed_source.path.should be_nil
         end
       end
+    end
+
+    describe '#syntax_error' do
+      context 'when the source is valid' do
+        let(:source) { "puts 'foo'" }
+
+        it 'returns nil' do
+          processed_source.error.should be_nil
+        end
+      end
+
+      context 'when the source is invalid' do
+        let(:source) { '<' }
+
+        it 'returns syntax error' do
+          processed_source.error.should be_a(Parser::SyntaxError)
+        end
+      end
 
-      context 'when the file has invalid source' do
-        it 'sets syntax error to the instance' do
-          processed_source = ProcessedSource.parse('<')
-          processed_source.syntax_error.should be_a(Parser::SyntaxError)
+      context 'when the source includes invalid byte sequence for the encoding' do
+        it 'returns encoding error' do
+          processed_source = ProcessedSource.new(<<-END)
+            # coding: utf-8
+            \xff
+          END
+          processed_source.error.should be_a(EncodingError)
         end
       end
     end
@@ -59,7 +85,7 @@ module Transpec
           "puts 'bar'"
         ].join("\n")
 
-        processed_source = ProcessedSource.parse(source)
+        processed_source = ProcessedSource.new(source)
         processed_source.to_s.should == source
       end
     end

data/spec/transpec/report_spec.rb

@@ -102,7 +102,7 @@ module Transpec
         report.records << Record.new('obj.stub(:message)', 'allow(obj).to receive(:message)')
         report.conversion_errors << ContextError.new('#should', '#expect', double('range'))
         report.conversion_errors << ContextError.new('#stub', '#allow', double('range'))
-        report.syntax_errors << double('syntax error')
+        report.file_errors << double('file error')
         report
       end
 
@@ -118,8 +118,8 @@ module Transpec
         concated_report.should have(3).conversion_errors
       end
 
-      it 'concats syntax errors' do
-        concated_report.should have(1).syntax_errors
+      it 'concats file errors' do
+        concated_report.should have(1).file_errors
       end
     end
   end

data/transpec.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 1.9.3'
 
-  spec.add_runtime_dependency 'parser',        '>= 2.1.6', '< 3.0'
+  spec.add_runtime_dependency 'parser',        '>= 2.2.0.pre.3', '< 3.0'
   spec.add_runtime_dependency 'astrolabe',     '>= 0.5.1', '< 0.6'
   spec.add_runtime_dependency 'bundler',       '~> 1.3'
   spec.add_runtime_dependency 'rainbow',       '>= 1.99.1', '< 3.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: transpec
 version: !ruby/object:Gem::Version
-  version: 2.3.4
+  version: 2.3.5
 platform: ruby
 authors:
 - Yuji Nakayama
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-16 00:00:00.000000000 Z
+date: 2014-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.6
+        version: 2.2.0.pre.3
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.6
+        version: 2.2.0.pre.3
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'