reek 3.1 → 3.2

data/spec/gem/yard_spec.rb

@@ -1,14 +1,11 @@
+require 'open3'
 require_relative '../spec_helper'
-require 'tempfile'
 
 RSpec.describe 'yardoc' do
-  before :each do
-    stderr_file = Tempfile.new('yardoc')
-    stderr_file.close
-    @stdout = `yardoc 2> #{stderr_file.path}`
-    @stderr = IO.read(stderr_file.path)
-  end
-  it 'raises no warnings' do
-    expect(@stderr).to eq('')
+  it 'executes successfully with no warnings' do
+    stdout, stderr, status = Open3.capture3('yardoc')
+    expect(stdout).to_not include('[warn]')
+    expect(stderr).to be_empty
+    expect(status).to be_success
   end
 end

data/spec/reek/code_comment_spec.rb

@@ -38,7 +38,7 @@ RSpec.describe Reek::CodeComment do
       expect(config['Duplication']).to include('enabled')
       expect(config['Duplication']['enabled']).to be_falsey
     end
-    it 'parses hashed options with ruby names' do
+    it 'parses hashed options with Ruby names' do
       comment = '# :reek:nested_iterators: { enabled: true }'
       config = described_class.new(comment).config
       expect(config).to include('NestedIterators')

data/spec/reek/report/xml_report_spec.rb

@@ -1,35 +1,25 @@
-require 'pathname'
 require_relative '../../spec_helper'
 require_relative '../../../lib/reek/examiner'
 require_relative '../../../lib/reek/report/report'
-require_relative '../../../lib/reek/report/formatter'
 
 RSpec.describe Reek::Report::XMLReport do
-  let(:instance) { Reek::Report::XMLReport.new }
+  let(:xml_report) { Reek::Report::XMLReport.new }
 
   context 'empty source' do
-    let(:examiner) { Reek::Examiner.new('') }
-
-    before do
-      instance.add_examiner examiner
-    end
-
-    it 'prints empty checkstyle xml' do
-      expect { instance.show }.to output("<?xml version='1.0'?>\n<checkstyle/>\n").to_stdout
+    it 'prints empty checkstyle XML' do
+      xml_report.add_examiner Reek::Examiner.new('')
+      xml = "<?xml version='1.0'?>\n<checkstyle/>\n"
+      expect { xml_report.show }.to output(xml).to_stdout
     end
   end
 
   context 'source with voliations' do
-    let(:examiner) { Reek::Examiner.new('def simple(a) a[0] end') }
-
-    before do
-      allow(File).to receive(:realpath).and_return('/some/path')
-      instance.add_examiner examiner
-    end
-
-    it 'prints non-empty checkstyle xml' do
-      sample_path = SAMPLES_PATH.join('checkstyle.xml')
-      expect { instance.show }.to output(sample_path.read).to_stdout
+    it 'prints non-empty checkstyle XML' do
+      path = SAMPLES_PATH.join('two_smelly_files/dirty_one.rb')
+      xml_report.add_examiner Reek::Examiner.new(path)
+      xml = SAMPLES_PATH.join('checkstyle.xml').read
+      xml = xml.gsub(path.to_s, path.expand_path.to_s)
+      expect { xml_report.show }.to output(xml).to_stdout
     end
   end
 end

data/spec/reek/smells/attribute_spec.rb

@@ -1,16 +1,8 @@
 require_relative '../../spec_helper'
 require_relative '../../../lib/reek/smells/attribute'
-require_relative '../../../lib/reek/smells/smell_configuration'
 require_relative 'smell_detector_shared'
 
 RSpec.describe Reek::Smells::Attribute do
-  let(:config) do
-    {
-      Reek::Smells::Attribute => { Reek::Smells::SmellConfiguration::ENABLED_KEY => true }
-    }
-  end
-  let(:configuration) { test_configuration_for(config) }
-
   before(:each) do
     @source_name = 'dummy_source'
     @detector = build(:smell_detector, smell_type: :Attribute, source: @source_name)
@@ -20,99 +12,123 @@ RSpec.describe Reek::Smells::Attribute do
 
   context 'with no attributes' do
     it 'records nothing' do
-      expect('
+      src = <<-EOS
         class Klass
         end
-      ').to_not reek_of(:Attribute, {}, configuration)
+      EOS
+      expect(src).to_not reek_of(:Attribute)
     end
   end
 
   context 'with attributes' do
-    it 'records nothing' do
-      expect('
+    it 'records nothing for attribute readers' do
+      src = <<-EOS
         class Klass
-          attr :super_private, :super_private2
-          private :super_private, :super_private2
-          private
-          attr :super_thing
-          public
-          attr :super_thing2
-          private
-          attr :super_thing2
+          attr :my_attr
+          attr_reader :my_attr2
         end
-      ').to_not reek_of(:Attribute, {}, configuration)
+      EOS
+      expect(src).to_not reek_of(:Attribute)
     end
 
-    it 'records attr attribute in a module' do
-      expect('
+    it 'records writer attribute' do
+      src = <<-EOS
+        class Klass
+          attr_writer :my_attr
+        end
+      EOS
+      expect(src).to reek_of(:Attribute, name: 'my_attr')
+    end
+
+    it 'records attr_writer attribute in a module' do
+      src = <<-EOS
         module Mod
-          attr :my_attr
+          attr_writer :my_attr
         end
-      ').to reek_of(:Attribute, { name: 'my_attr' }, configuration)
+      EOS
+      expect(src).to reek_of(:Attribute, name: 'my_attr')
     end
 
-    it 'records attr attribute' do
-      expect('
+    it 'records accessor attribute' do
+      src = <<-EOS
         class Klass
-          attr :my_attr
+          attr_accessor :my_attr
         end
-      ').to reek_of(:Attribute, { name: 'my_attr' }, configuration)
+      EOS
+      expect(src).to reek_of(:Attribute, name: 'my_attr')
     end
 
-    it 'records reader attribute' do
-      expect('
+    it 'records attr defining a writer' do
+      src = <<-EOS
         class Klass
-          attr_reader :my_attr
+          attr :my_attr, true
         end
-      ').to reek_of(:Attribute, { name: 'my_attr' }, configuration)
+      EOS
+      expect(src).to reek_of(:Attribute, name: 'my_attr')
     end
 
-    it 'records writer attribute' do
-      expect('
+    it "doesn't record protected attributes" do
+      src = '
         class Klass
-          attr_writer :my_attr
+          protected
+          attr_writer :attr1
+          attr_accessor :attr2
+          attr :attr3
+          attr :attr4, true
+          attr_reader :attr5
         end
-      ').to reek_of(:Attribute, { name: 'my_attr' }, configuration)
+      '
+      expect(src).to_not reek_of(:Attribute)
     end
 
-    it 'records accessor attribute' do
-      expect('
+    it "doesn't record private attributes" do
+      src = '
         class Klass
-          attr_accessor :my_attr
+          private
+          attr_writer :attr1
+          attr_accessor :attr2
+          attr :attr3
+          attr :attr4, true
+          attr_reader :attr5
         end
-      ').to reek_of(:Attribute, { name: 'my_attr' }, configuration)
+      '
+      expect(src).to_not reek_of(:Attribute)
     end
 
-    it 'records attr attribute after switching visbility' do
-      expect('
+    it 'records attr_writer defined in public section' do
+      src = <<-EOS
         class Klass
           private
-          attr :my_attr
-          public :my_attr
-          private :my_attr
-          public :my_attr
+          public
+          attr_writer :my_attr
         end
-      ').to reek_of(:Attribute, { name: 'my_attr' }, configuration)
+      EOS
+      expect(src).to reek_of(:Attribute, name: 'my_attr')
     end
 
-    it "doesn't record protected attributes" do
-      src = '
+    it 'records attr_writer after switching visbility to public' do
+      src = <<-EOS
         class Klass
-          protected
-          attr :iam_protected
+          private
+          attr_writer :my_attr
+          public :my_attr
         end
-      '
-      expect(src).to_not reek_of(:Attribute, { name: 'iam_protected' }, configuration)
+      EOS
+      expect(src).to reek_of(:Attribute, name: 'my_attr')
     end
 
-    it "doesn't record private attributes" do
+    it 'resets visibility in new contexts' do
       src = '
         class Klass
           private
-          attr :iam_private
+          attr_writer :attr1
+        end
+
+        class OtherKlass
+          attr_writer :attr1
         end
       '
-      expect(src).to_not reek_of(:Attribute, { name: 'iam_private' }, configuration)
+      expect(src).to reek_of(:Attribute)
     end
   end
 end

data/spec/reek/smells/too_many_instance_variables_spec.rb

@@ -10,12 +10,26 @@ RSpec.describe Reek::Smells::TooManyInstanceVariables do
 
   it_should_behave_like 'SmellDetector'
 
+  def default_max_ivars
+    Reek::Smells::TooManyInstanceVariables::DEFAULT_MAX_IVARS
+  end
+
+  def too_many_ivars
+    default_max_ivars + 1
+  end
+
+  def ivar_sequence(count: default_max_ivars, alphabet: ('a'..'z').to_a)
+    alphabet.first(count).map do |name|
+      "@#{name}=#{rand}"
+    end.join(',')
+  end
+
   context 'counting instance variables' do
-    it 'should not report 9 ivars' do
+    it 'should not report for non-excessive ivars' do
       src = <<-EOS
         class Empty
           def ivars
-            @aa=@ab=@ac=@ad=@ae=@af=@ag=@ah=@ai=4
+           #{ivar_sequence}
           end
         end
       EOS
@@ -26,36 +40,36 @@ RSpec.describe Reek::Smells::TooManyInstanceVariables do
       src = <<-EOS
         class Empty
           def ivars
-            @aa=@ab=@ac=@ad=@ae=@af=@ag=@ah=@ai=4
-            @aa=3
+           #{ivar_sequence}
+           #{ivar_sequence}
           end
         end
       EOS
       expect(src).not_to reek_of(:TooManyInstanceVariables)
     end
 
-    it 'should report 10 ivars' do
+    it 'should report excessive ivars' do
       src = <<-EOS
         class Empty
           def ivars
-            @aa=@ab=@ac=@ad=@ae=@af=@ag=@ah=@ai=@aj=4
+            #{ivar_sequence(count: too_many_ivars)}
           end
         end
       EOS
       expect(src).to reek_of(:TooManyInstanceVariables)
     end
 
-    it 'should not report 10 ivars in 2 extensions' do
+    it 'should not report for ivars in 2 extensions' do
       src = <<-EOS
         class Full
           def ivars_a
-            @aa=@ab=@ac=@ad=@ae
+            #{ivar_sequence}
           end
         end
 
         class Full
           def ivars_b
-            @af=@ag=@ah=@ai=@aj
+            #{ivar_sequence}
           end
         end
       EOS
@@ -63,12 +77,12 @@ RSpec.describe Reek::Smells::TooManyInstanceVariables do
     end
   end
 
-  it 'reports correctly when the class has 10 instance variables' do
+  it 'reports correctly for excessive instance variables' do
     src = <<-EOS
       # Comment
       class Empty
         def ivars
-          @aa=@ab=@ac=@ad=@ae=@af=@ag=@ah=@ai=@aj=4
+          #{ivar_sequence(count: too_many_ivars)}
         end
       end
     EOS
@@ -77,7 +91,7 @@ RSpec.describe Reek::Smells::TooManyInstanceVariables do
     expect(@warning.source).to eq(@source_name)
     expect(@warning.smell_category).to eq(Reek::Smells::TooManyInstanceVariables.smell_category)
     expect(@warning.smell_type).to eq(Reek::Smells::TooManyInstanceVariables.smell_type)
-    expect(@warning.parameters[:count]).to eq(10)
+    expect(@warning.parameters[:count]).to eq(too_many_ivars)
     expect(@warning.lines).to eq([2])
   end
 end

data/spec/reek/source/source_locator_spec.rb

@@ -46,7 +46,7 @@ RSpec.describe Reek::Source::SourceLocator do
       end
     end
 
-    context 'non-ruby paths' do
+    context 'non-Ruby paths' do
       let(:path) { SAMPLES_PATH.join('source_with_non_ruby_files') }
       let(:expected_sources) do
         [SAMPLES_PATH.join('source_with_non_ruby_files/uncommunicative_parameter_name.rb')]
@@ -58,7 +58,7 @@ RSpec.describe Reek::Source::SourceLocator do
         ]
       end
 
-      it 'does only use ruby source paths' do
+      it 'does only use Ruby source paths' do
         sources = described_class.new([path]).sources
 
         expect(sources).not_to include(*paths_that_are_expected_to_be_ignored)

data/spec/samples/checkstyle.xml

@@ -1,2 +1,13 @@
 <?xml version='1.0'?>
-<checkstyle><file name='/some/path'><error column='0' line='1' message='doesn&apos;t depend on instance state' severity='warning' source='UtilityFunction'/><error column='0' line='1' message='has the parameter name &apos;a&apos;' severity='warning' source='UncommunicativeParameterName'/></file></checkstyle>
+<checkstyle>
+  <file name='spec/samples/two_smelly_files/dirty_one.rb'>
+    <error column='0' line='5' message='has the variable name &apos;@s&apos;' severity='warning' source='UncommunicativeVariableName'/>
+    <error column='0' line='4' message='calls @s.title 2 times' severity='warning' source='DuplicateMethodCall'/>
+    <error column='0' line='6' message='calls @s.title 2 times' severity='warning' source='DuplicateMethodCall'/>
+    <error column='0' line='4' message='calls puts(@s.title) 2 times' severity='warning' source='DuplicateMethodCall'/>
+    <error column='0' line='6' message='calls puts(@s.title) 2 times' severity='warning' source='DuplicateMethodCall'/>
+    <error column='0' line='5' message='contains iterators nested 2 deep' severity='warning' source='NestedIterators'/>
+    <error column='0' line='3' message='has the name &apos;a&apos;' severity='warning' source='UncommunicativeMethodName'/>
+    <error column='0' line='5' message='has the variable name &apos;x&apos;' severity='warning' source='UncommunicativeVariableName'/>
+  </file>
+</checkstyle>

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
 require 'pathname'
+require_relative '../lib/reek'
 require_relative '../lib/reek/spec'
 require_relative '../lib/reek/ast/ast_node_class_map'
 require_relative '../lib/reek/configuration/app_configuration'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reek
 version: !ruby/object:Gem::Version
-  version: '3.1'
+  version: '3.2'
 platform: ruby
 authors:
 - Kevin Rutherford
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-21 00:00:00.000000000 Z
+date: 2015-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -26,6 +26,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.2.2.5
+- !ruby/object:Gem::Dependency
+  name: private_attr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rainbow
   requirement: !ruby/object:Gem::Requirement
@@ -74,14 +88,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.2
+        version: 0.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.2
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: ataru
   requirement: !ruby/object:Gem::Requirement
@@ -189,14 +203,14 @@ executables:
 - reek
 extensions: []
 extra_rdoc_files:
-- CHANGELOG
+- CHANGELOG.md
 - License.txt
 files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
 - ".yardopts"
-- CHANGELOG
+- CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
 - License.txt
@@ -429,7 +443,6 @@ files:
 - spec/samples/three_clean_files/clean_two.rb
 - spec/samples/two_smelly_files/dirty_one.rb
 - spec/samples/two_smelly_files/dirty_two.rb
-- spec/samples/unusual_syntax.rb
 - spec/spec_helper.rb
 - tasks/develop.rake
 - tasks/reek.rake