wool 0.5.1

data/spec/runner_spec.rb

@@ -0,0 +1,171 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Runner do
+  before do
+    @runner = Runner.new(['a', :b])
+  end
+
+  context '#run' do
+    it 'collects options and arguments, decides what to scan, scans, and displays' do
+      runner = Runner.new(['--report-fixed', 'hello', 'world'])
+      expected_settings = {:"report-fixed_given"=>true, :"report-fixed"=>true,
+                           :fix => false, :help => false, :debug => false,
+                           InlineCommentSpaceWarning::OPTION_KEY => 2,
+                           :"line-length" => nil, :only => nil, :stdin => false,
+                           :display => true,
+                           :__using__ => Warning.all_warnings,
+                           :__fix__ => Warning.all_warnings}
+      scanner = mock(:scanner)
+      Scanner.should_receive(:new, expected_settings).and_return(scanner)
+
+      data1, data2 = mock(:data1), mock(:data2)
+      warning1, warning2 = mock(:warning1), mock(:warning2)
+      file1, file2 = mock(:file1), mock(:file2)
+
+      scanner.should_receive(:settings).exactly(3).times.and_return({:"report-fixed" => true})
+      File.should_receive(:read).with('hello').and_return(data1)
+      scanner.should_receive(:scan).
+              with(data1, 'hello').
+              and_return([warning1])
+      warning1.should_receive(:to_ary)
+
+      scanner.should_receive(:settings).and_return({})
+      File.should_receive(:read).with('world').and_return(data2)
+      scanner.should_receive(:scan).
+              with(data2, 'world').
+              and_return([warning2])
+      warning2.should_receive(:to_ary)
+
+      runner.should_receive(:display_warnings).with([warning1, warning2], expected_settings)
+
+      runner.run
+    end
+    
+    it 'works with :stdin => true' do
+      runner = Runner.new(['--stdin', '--only', 'UselessDoubleQuotesWarning'])
+      expected_settings = {:"report-fixed"=>false, :fix => false, :help => false,
+                           :debug => false, InlineCommentSpaceWarning::OPTION_KEY => 2,
+                           :"line-length" => nil, :only => 'UselessDoubleQuotesWarning',
+                           :stdin => true, :stdin_given => true, :only_given => true,
+                           :display => true,
+                           :__using__ => [UselessDoubleQuotesWarning],
+                           :__fix__ => [UselessDoubleQuotesWarning]}
+      scanner = mock(:scanner)
+      Scanner.should_receive(:new, expected_settings).and_return(scanner)
+
+      data1 = mock(:data1)
+      warning1 = mock(:warning1)
+
+      scanner.should_receive(:settings).twice.and_return({:"report-fixed" => true})
+      STDIN.should_receive(:read).and_return(data1)
+      scanner.should_receive(:scan).
+              with(data1, '(stdin)').
+              and_return([warning1])
+      warning1.should_receive(:to_ary)
+
+      runner.should_receive(:display_warnings).with([warning1], expected_settings)
+      runner.run
+    end
+  end
+
+  context '#collect_options_and_arguments' do
+    before do
+      @runner = Runner.new(['--fix', '--report-fixed', 'hello', 'there'])
+      @settings, @arguments = @runner.collect_options_and_arguments
+    end
+
+    it 'finds both flags' do
+      @settings[:fix].should be_true
+      @settings[:"report-fixed"].should be_true
+    end
+
+    it 'finds both stray arguments' do
+      @arguments.should == ['hello', 'there']
+    end
+  end
+
+  context '#swizzling_argv' do
+    it 'changes ARGV to the runner\'s argv value' do
+      @runner.swizzling_argv do
+        ARGV.should == ['a', :b]
+      end
+    end
+
+    it 'restores ARGV despite an exception' do
+      old_argv = ARGV.dup
+      proc {
+        @runner.swizzling_argv do
+          raise SystemExit.new('exiting')
+        end
+      }.should raise_error(SystemExit)
+      ARGV.should == old_argv
+    end
+  end
+
+  context '#get_settings' do
+    it 'has a --fix option' do
+      runner = Runner.new(['--fix'])
+      settings = runner.swizzling_argv { runner.get_settings }
+      settings[:fix].should be_true
+      settings[:fix_given].should be_true
+    end
+
+    it 'has a --report-fixed option' do
+      runner = Runner.new(['--report-fixed'])
+      settings = runner.swizzling_argv { runner.get_settings }
+      settings[:"report-fixed"].should be_true
+      settings[:"report-fixed_given"].should be_true
+    end
+  end
+
+  context '#handle_global_options' do
+    it 'specifies :using and :fix when :only is provided' do
+      runner = Runner.new([])
+      runner.handle_global_options(:only => 'UselessDoubleQuotesWarning')
+      runner.using.should == [UselessDoubleQuotesWarning]
+      runner.fix.should == [UselessDoubleQuotesWarning]
+    end
+    
+    it 'works with multiple short names' do
+      runner = Runner.new([])
+      runner.handle_global_options(:only => 'ST1,ST3')
+      runner.using.size.should == 2
+      runner.using.each {|w| w.ancestors.should include(Warning) }
+    end
+  end
+
+  context '#display_warnings' do
+    it 'prints the lines and files where there are warnings' do
+      warning = Warning.new('hello', 'a+b')
+      warning.line_number = 4
+      warning.severity = 3
+      warnings = [warning]
+      runner = Runner.new(['temp', 'hello'])
+      output = swizzling_io do
+        runner.display_warnings(warnings, {})
+      end
+      output.should =~ /hello:4/
+      output.should =~ /(3)/
+      output.should =~ /Warning/
+      output.should =~ /1 warning/
+      output.should =~ /0 are fixable/
+    end
+  end
+
+  context '#collect_warnings' do
+    it 'scans each file provided' do
+      scanner = mock(:scanner)
+      data1, data2 = mock(:data1), mock(:data2)
+      warning_list1, warning_list2 = mock(:wl1), mock(:wl2)
+      File.should_receive(:read).with('abc').and_return(data1)
+      scanner.should_receive(:settings).exactly(4).times.and_return({})
+      scanner.should_receive(:scan).with(data1, 'abc').and_return(warning_list1)
+      warning_list1.should_receive(:to_ary)
+      File.should_receive(:read).with('def').and_return(data2)
+      scanner.should_receive(:scan).with(data2, 'def').and_return(warning_list2)
+      warning_list2.should_receive(:to_ary)
+
+      @runner.collect_warnings(['abc', 'def'], scanner).should == [warning_list1, warning_list2]
+    end
+  end
+end

data/spec/scanner_spec.rb

@@ -0,0 +1,75 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'stringio'
+
+describe Scanner do
+  before do
+    @scanner = Scanner.new(InlineCommentSpaceWarning::OPTION_KEY => 2)
+
+    @fix_scanner_stdout = StringIO.new
+    @fix_scanner = Scanner.new(:fix => true, :output_file => @fix_scanner_stdout)
+  end
+
+  context '#scan' do
+    it 'takes an input and gathers warnings about it' do
+      warnings = @scanner.scan('a + b ', '(stdin)')
+      warnings.size.should == 1
+      warnings[0].should be_a(ExtraWhitespaceWarning)
+    end
+
+    it "ignores warnings specified in the line's comments by class name" do
+      warnings = @scanner.scan('a +b  # wool: ignore OperatorSpacing')
+      warnings.size.should == 0
+    end
+
+    it "ignores warnings specified in the line's comments by short name" do
+      warnings = @scanner.scan("a +b  # wool: ignore #{OperatorSpacing.short_name}")
+      warnings.size.should == 0
+    end
+
+    it "ignores multiple warnings that are marked in the line's comments" do
+      warnings = @scanner.scan(
+          'a +b; c + d  # wool: ignore OperatorSpacing SemicolonWarning')
+      warnings.size.should == 0
+    end
+
+    it "ignores multiple warnings in the line's comments as short name" do
+      warnings = @scanner.scan(
+          "a +b; c + d  # wool: ignore #{OperatorSpacing.short_name} #{SemicolonWarning.short_name}")
+      warnings.size.should == 0
+    end
+
+    it 'fixes the input and writes it to :output_file' do
+      warnings = @fix_scanner.scan('a + b ', '(stdin)')
+      warnings.size.should == 1
+      warnings[0].should be_a(ExtraWhitespaceWarning)
+      @fix_scanner_stdout.string.should == "a + b"
+    end
+
+    it 'fixes multiple errors on one line' do
+      warnings = @fix_scanner.scan('a +b ', '(stdin)')
+      warnings.size.should == 2
+      @fix_scanner_stdout.string.should == "a + b"
+    end
+
+    it 'fixes multiline inputs' do
+      warnings = @fix_scanner.scan("def plus(a, b)\n  a + b \nend", '(stdin)')
+      warnings.size.should == 1
+      warnings[0].should be_a(ExtraWhitespaceWarning)
+      @fix_scanner_stdout.string.should == "def plus(a, b)\n  a + b\nend"
+    end
+
+    it 'fixes multiline mis-indented inputs' do
+      warnings = @fix_scanner.scan("def plus(a, b)\n  a + b\n end", '(stdin)')
+      warnings.size.should == 1
+      warnings[0].should be_a(MisalignedUnindentationWarning)
+      @fix_scanner_stdout.string.should == "def plus(a, b)\n  a + b\nend"
+    end
+
+    it 'fixes class definitions' do
+      warnings = @fix_scanner.scan("class Hello\n  a+b\nend", '(stdin)')
+      warnings.size.should == 1
+      warnings[0].should be_a(OperatorSpacing)
+      @fix_scanner_stdout.string.should == "class Hello\n  a + b\nend"
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color --backtrace

data/spec/spec_helper.rb

@@ -0,0 +1,93 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'simplecov'
+require 'simplecov-gem-adapter'
+SimpleCov.start 'gem'
+require 'wool'
+require 'spec'
+require 'spec/autorun'
+require 'stringio'
+
+
+include Wool
+
+module Wool
+  module RSpec
+    module Matchers
+      # Matcher for checking if #match? returns trues
+      class Warns
+        def initialize(input, *args)
+          @input, @args = input, args
+        end
+
+        def matches?(actual)
+          @class = actual
+          result = @class.new('(stdin)', @input, *@args).match?
+          result && result != [] # empty list is also failure to find any warnings
+        end
+
+        def failure_message
+          "expected '#{@actual}' to match #{@input.inspect}"
+        end
+
+        def negative_failure_message
+          "expected '#{@actual}' to not match #{@input.inspect}"
+        end
+      end
+
+      def warn(input, *args)
+        Warns.new(input, *args)
+      end
+
+      # Matcher for comparing input/output of #fix
+      class CorrectsTo
+        def initialize(input, output, *args)
+          @input, @output, @args = input, output, args
+        end
+
+        def matches?(actual)
+          @class = actual
+          @class.new('(stdin)', @input, *@args).fix == @output
+        end
+
+        def failure_message
+          "expected '#{@input}' to correct to #{@output.inspect}"
+        end
+
+        def negative_failure_message
+          "expected '#{@input}' to not correct to #{@output.inspect}"
+        end
+      end
+
+      def correct_to(input, output, *args)
+        CorrectsTo.new(input, output, *args)
+      end
+    end
+  end
+end
+
+Spec::Runner.configure do |config|
+  config.include(Wool::RSpec::Matchers)
+end
+
+def with_examples(*args)
+  args.each do |arg|
+    yield arg
+  end
+end
+
+def swizzling_io
+  old_stdout, $stdout = $stdout, StringIO.new
+  yield
+  return $stdout.string
+ensure
+  $stdout = old_stdout
+end
+
+def swizzling_stdin
+  old_stdin, $stdin = $stdin, StringIO.new
+  yield $stdin
+  return $stdin.string
+ensure
+  $stdin = old_stdin
+end

data/spec/support_specs/module_extensions_spec.rb

@@ -0,0 +1,91 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe ModuleExtensions do
+  before do
+    @class = Class.new do
+      extend ModuleExtensions
+      cattr_reader :read1, :read2
+      cattr_writer :write1, :write2
+      cattr_accessor :both1, :both2
+      cattr_accessor_with_default :arr1, []
+    end
+  end
+
+  describe '#cattr_reader' do
+    it 'creates reading methods for the given variables' do
+      @class.__send__(:instance_variable_set, :@read1, 'hello')
+      @class.read1.should == 'hello'
+      @class.__send__(:instance_variable_set, :@read2, 5)
+      @class.read2.should == 5
+    end
+  end
+
+  describe '#cattr_writer' do
+    it 'creates writing methods for the given variables' do
+      @class.write1 = 'hello'
+      @class.__send__(:instance_variable_get, :@write1).should == 'hello'
+      @class.write2 = 5
+      @class.__send__(:instance_variable_get, :@write2).should == 5
+    end
+  end
+
+  describe '#cattr_accessor' do
+    it 'creates reading and writing methods for the given variables' do
+      @class.both1 = 'hello'
+      @class.both1.should == 'hello'
+      @class.__send__(:instance_variable_get, :@both1).should == 'hello'
+      @class.__send__(:instance_variable_set, :@both1, 'world')
+      @class.both1.should == 'world'
+      @class.both2 = 5
+      @class.both2.should == 5
+      @class.__send__(:instance_variable_get, :@both2).should == 5
+      @class.__send__(:instance_variable_set, :@both2, 10)
+      @class.both2.should == 10
+    end
+  end
+
+  describe '#cattr_accessor_with_default' do
+    it 'creates reading and writing methods, but defaults the ivar value' do
+      @class.arr1.should == []
+      @class.__send__(:instance_variable_get, :@arr1).should == []
+      @class.arr1.should == [] # second invocation, after default value set
+      @class.arr1 = [1, 2]
+      @class.arr1.should == [1, 2]
+      @class.__send__(:instance_variable_get, :@arr1).should == [1, 2]
+    end
+  end
+
+  describe '#cattr_get_and_setter' do
+    before do
+      @base = Class.new do
+        extend ModuleExtensions
+        cattr_get_and_setter :type
+        type :silly
+      end
+    end
+
+    it 'acts a setter and getter on the base class' do
+      @base.type.should == :silly
+    end
+
+    it 'is not inherited' do
+      @derived = Class.new(@base)
+      @derived.type.should_not == :silly
+    end
+
+    it 'can be used by inherited classes' do
+      @derived = Class.new(@base) do
+        type :laughable
+      end
+      @derived.type.should == :laughable
+      @base.type.should == :silly
+    end
+
+    it 'turns a block into a proc and sets it' do
+      @derived = Class.new(@base) do
+        type { 5 + 3 }
+      end
+      @derived.type.call.should == 8
+    end
+  end
+end

data/spec/support_specs/spec_helper.rb

@@ -0,0 +1 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')

data/spec/warning_spec.rb

@@ -0,0 +1,95 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Warning do
+  context 'when subclassed' do
+    it 'registers the new class in all_warnings' do
+      klass = Class.new(Warning)
+      Warning.all_warnings.should include(klass)
+    end
+  end
+
+  it 'does not match anything' do
+    Warning.should_not warn('hello(world)')
+    Warning.should_not warn(' a +b  ')
+  end
+
+  describe 'short names in warnings' do
+    before do
+      @real_warnings = Warning.all_warnings.select do |x|
+        x.name && x != Warning && x != FileWarning && x != LineWarning
+      end
+    end
+
+    it 'exist for every warning class' do
+      @real_warnings.select {|x| x.name && x.short_name == nil}.should be_empty
+    end
+
+    it 'do not conflict with each other' do
+      short_names = @real_warnings.map {|x| x.short_name}.uniq
+      short_names.size.should == @real_warnings.size
+    end
+  end
+
+  it 'does not change lines when it fixes them' do
+    Warning.should correct_to('a+b', 'a+b')
+    Warning.should correct_to(' b **   c+1 eval(string) ', ' b **   c+1 eval(string) ')
+  end
+
+  context '#concrete_warnings' do
+    before { @concrete = Warning.concrete_warnings }
+    it 'returns a list of classes that are subclasses of Warning' do
+      @concrete.should_not be_empty
+      @concrete.each {|w| w.ancestors.should include(Warning) }
+    end
+    
+    it 'returns a list that does not contain Warning, FileWarning, or LineWarning' do
+      @concrete.should_not include(Warning)
+      @concrete.should_not include(FileWarning)
+      @concrete.should_not include(LineWarning)
+    end
+  end
+
+  context '#desc' do
+    it "defaults to the class's name with all info" do
+      warning = Warning.new('hello.rb', 'a+b')
+      warning.severity = 7
+      warning.line_number = 3
+      warning.desc.should == 'Wool::Warning hello.rb:3 (7)'
+    end
+
+    it 'when specified in a subclass as a string, just uses the string' do
+      subclass = Class.new(Warning) { desc 'hello' }
+      subclass.new('a', 'b').desc.should == 'hello'
+    end
+
+    it 'when specified in a subclass as a block, runs that proc as the instance' do
+      subclass = Class.new(Warning) do
+        severity 1024
+        desc { self.class.severity.to_s }
+      end
+      subclass.new('a', 'b').desc.should == '1024'
+    end
+  end
+
+  context '#type' do
+    it 'returns the current type when no args are provided' do
+      klass = Class.new(Warning) do
+        def self.set_type
+          @type = 'hai'
+        end
+      end
+      klass.set_type
+      klass.type.should == 'hai'
+    end
+
+    it 'sets the type when an argument is provided' do
+      klass = Class.new(Warning) { type :silly }
+      klass.type.should == 'silly'
+    end
+
+    it 'sets a short name based on the type provided' do
+      klass = Class.new(Warning) { type :silly }
+      klass.short_name.should =~ /SI\d/
+    end
+  end
+end