rubycritic 3.4.0 → 3.5.0

data/test/lib/rubycritic/core/location_test.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-require 'test_helper'
-require 'rubycritic/core/location'
-
-describe RubyCritic::Location do
-  describe 'attribute readers' do
-    before do
-      @path = './foo.rb'
-      @line = '42'
-      @location = RubyCritic::Location.new(@path, @line)
-    end
-
-    it 'has a pathname' do
-      @location.pathname.must_equal Pathname.new(@path)
-    end
-
-    it 'has a line number' do
-      @location.line.must_equal @line.to_i
-    end
-
-    it 'has a file name' do
-      @location.file_name.must_equal 'foo'
-    end
-  end
-
-  it 'is comparable' do
-    location1 = RubyCritic::Location.new('./foo', 42)
-    location2 = RubyCritic::Location.new('./foo', 42)
-    location1.must_equal location2
-  end
-
-  it 'is sortable' do
-    location1 = RubyCritic::Location.new('./foo', 42)
-    location2 = RubyCritic::Location.new('./bar', 23)
-    location3 = RubyCritic::Location.new('./bar', 16)
-    [location1, location2, location3].sort.must_equal [location3, location2, location1]
-  end
-end

data/test/lib/rubycritic/core/smell_test.rb

@@ -1,105 +0,0 @@
-# frozen_string_literal: true
-
-require 'test_helper'
-require 'rubycritic/core/smell'
-
-describe RubyCritic::Smell do
-  describe 'attribute readers' do
-    before do
-      @locations = [RubyCritic::Location.new('./foo', '42')]
-      @context = '#bar'
-      @message = 'This smells'
-      @score = 0
-      @type = :complexity
-      @smell = RubyCritic::Smell.new(
-        locations: @locations,
-        context: @context,
-        message: @message,
-        score: @score,
-        type: @type
-      )
-    end
-
-    it 'has a context reader' do
-      @smell.context.must_equal @context
-    end
-
-    it 'has a locations reader' do
-      @smell.locations.must_equal @locations
-    end
-
-    it 'has a message reader' do
-      @smell.message.must_equal @message
-    end
-
-    it 'has a score reader' do
-      @smell.score.must_equal @score
-    end
-
-    it 'has a type reader' do
-      @smell.type.must_equal @type
-    end
-  end
-
-  describe '#at_location?' do
-    it 'returns true if the smell has a location that matches the location passed as argument' do
-      location = RubyCritic::Location.new('./foo', '42')
-      smell = RubyCritic::Smell.new(locations: [location])
-      smell.at_location?(location).must_equal true
-    end
-  end
-
-  describe '#multiple_locations?' do
-    it 'returns true if the smell has more than one location' do
-      location1 = RubyCritic::Location.new('./foo', '42')
-      location2 = RubyCritic::Location.new('./foo', '23')
-      smell = RubyCritic::Smell.new(locations: [location1, location2])
-      smell.multiple_locations?.must_equal true
-    end
-  end
-
-  describe '#==' do
-    it 'returns true if two smells have the same base attributes' do
-      attributes = {
-        context: '#bar',
-        message: 'This smells',
-        score: 0,
-        type: :complexity
-      }
-      smell1 = RubyCritic::Smell.new(attributes)
-      smell2 = RubyCritic::Smell.new(attributes)
-      smell1.must_equal smell2
-    end
-  end
-
-  describe '#doc_url' do
-    it 'handles one word type names for reek smells' do
-      smell = RubyCritic::Smell.new(type: 'Complexity', analyser: 'reek')
-
-      smell.doc_url.must_equal('https://github.com/troessner/reek/blob/master/docs/Complexity.md')
-    end
-
-    it 'handles multiple word type names for reek smells' do
-      smell = RubyCritic::Smell.new(type: 'TooManyStatements', analyser: 'reek')
-
-      smell.doc_url.must_equal('https://github.com/troessner/reek/blob/master/docs/Too-Many-Statements.md')
-    end
-
-    it 'handles flay smells' do
-      smell = RubyCritic::Smell.new(type: 'DuplicateCode', analyser: 'flay')
-
-      smell.doc_url.must_equal('http://docs.seattlerb.org/flay/')
-    end
-
-    it 'handles flog smells' do
-      smell = RubyCritic::Smell.new(type: 'VeryHighComplexity', analyser: 'flog')
-
-      smell.doc_url.must_equal('http://docs.seattlerb.org/flog/')
-    end
-
-    it 'raises an error for unknown analysers' do
-      smell = RubyCritic::Smell.new(type: 'FooSmell', analyser: 'foo')
-      assert_raises { smell.doc_url }
-    end
-  end
-end

data/test/lib/rubycritic/core/smells_array_test.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-require 'test_helper'
-require 'rubycritic/core/smell'
-
-describe 'Array of Smells' do
-  it 'is sortable' do
-    location1 = RubyCritic::Location.new('./foo', 42)
-    location2 = RubyCritic::Location.new('./bar', 23)
-    location3 = RubyCritic::Location.new('./bar', 16)
-    smell1 = RubyCritic::Smell.new(locations: [location1])
-    smell2 = RubyCritic::Smell.new(locations: [location2])
-    smell3 = RubyCritic::Smell.new(locations: [location3])
-    [smell1, smell2, smell3].sort.must_equal [smell3, smell2, smell1]
-  end
-
-  it 'implements set intersection' do
-    smell1 = RubyCritic::Smell.new(context: '#bar')
-    smell2 = RubyCritic::Smell.new(context: '#bar')
-    smell3 = RubyCritic::Smell.new(context: '#foo')
-    ([smell1, smell3] & [smell2]).must_equal [smell1]
-  end
-
-  it 'implements set union' do
-    smell1 = RubyCritic::Smell.new(context: '#bar')
-    smell2 = RubyCritic::Smell.new(context: '#bar')
-    smell3 = RubyCritic::Smell.new(context: '#foo')
-    ([smell1, smell3] | [smell2]).must_equal [smell1, smell3]
-  end
-end

data/test/lib/rubycritic/generators/console_report_test.rb

@@ -1,83 +0,0 @@
-# frozen_string_literal: true
-
-require 'test_helper'
-require 'rubycritic/generators/console_report'
-require 'rubycritic/core/rating'
-require 'rubycritic/core/smell'
-
-describe RubyCritic::Generator::ConsoleReport do
-  describe '#generate_report' do
-    before do
-      @mock_analysed_module = mock_analysed_module
-      capture_output_streams do
-        report = RubyCritic::Generator::ConsoleReport.new([@mock_analysed_module])
-        report.generate_report
-        @output = $stdout.tap(&:rewind).read
-      end
-    end
-
-    it 'outputs the report to the stdout' do
-      assert !@output.empty?, 'expected report to be output to stdout'
-    end
-
-    it "starts the report with the module's name" do
-      lines = @output.split("\n")
-      assert lines[0][/#{mock_analysed_module.name}/]
-    end
-
-    it "includes the module's rating in the report" do
-      assert output_contains?('Rating', @mock_analysed_module.rating)
-    end
-
-    it "includes the module's churn metric in the report" do
-      assert output_contains?('Churn', @mock_analysed_module.churn)
-    end
-
-    it "includes the module's complexity in the report" do
-      assert output_contains?('Complexity', @mock_analysed_module.complexity)
-    end
-
-    it "includes the module's duplication metric in the report" do
-      assert output_contains?('Duplication', @mock_analysed_module.duplication)
-    end
-
-    it 'includes the number of smells in the report' do
-      assert output_contains?('Smells', @mock_analysed_module.smells.count)
-    end
-
-    it 'includes the smell and its attributes in the report' do
-      @mock_analysed_module.smells.each do |smell|
-        assert output_contains?(smell), 'expected smell type and context to be reported'
-        smell.locations.each do |location|
-          assert output_contains?(location), 'expected all smell locations to be reported'
-        end
-      end
-    end
-
-    def output_contains?(*strs)
-      @lines ||= @output.split("\n")
-      expr = strs.map(&:to_s).map! { |s| Regexp.escape(s) }.join('.*')
-      @lines.any? { |l| l[/#{expr}/] }
-    end
-
-    def mock_analysed_module
-      OpenStruct.new(
-        name: 'TestModule',
-        rating: RubyCritic::Rating.from_cost(3),
-        churn: 10,
-        complexity: 0,
-        duplication: 20,
-        smells: [mock_smell]
-      )
-    end
-
-    def mock_smell
-      smell = RubyCritic::Smell.new
-      smell.locations << RubyCritic::Location.new(__FILE__, 3)
-      smell.type = 'SmellySmell'
-      smell.context = 'You'
-      smell.message = 'Seriously, take a shower or something'
-      smell
-    end
-  end
-end

data/test/lib/rubycritic/generators/json_report_test.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-require 'test_helper'
-require 'rubycritic/analysers_runner'
-require 'rubycritic/generators/json_report'
-require 'json'
-require 'fakefs/safe'
-
-describe RubyCritic::Generator::JsonReport do
-  describe '#generate_report' do
-    around do |example|
-      capture_output_streams do
-        with_cloned_fs(&example)
-      end
-    end
-
-    it 'creates a report file with JSON data inside' do
-      sample_files = Dir['test/samples/**/*.rb']
-      create_analysed_modules_collection
-      generate_report
-      data = JSON.parse(File.read('test/samples/report.json'))
-      analysed_files = data['analysed_modules'].map { |h| h['path'] }.uniq
-      assert_matched_arrays analysed_files, sample_files
-    end
-  end
-
-  def create_analysed_modules_collection
-    RubyCritic::Config.root = 'test/samples'
-    RubyCritic::Config.source_control_system = RubyCritic::SourceControlSystem::Git.new
-    analyser_runner = RubyCritic::AnalysersRunner.new('test/samples/')
-    @analysed_modules_collection = analyser_runner.run
-  end
-
-  def generate_report
-    report = RubyCritic::Generator::JsonReport.new(@analysed_modules_collection)
-    report.generate_report
-  end
-end

data/test/lib/rubycritic/generators/lint_report_test.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-require 'test_helper'
-require 'rubycritic/analysers_runner'
-require 'rubycritic/generators/lint_report'
-require 'fakefs/safe'
-
-describe RubyCritic::Generator::LintReport do
-  describe '#generate_report' do
-    around do |example|
-      capture_output_streams do
-        with_cloned_fs(&example)
-      end
-    end
-
-    it 'report file has data inside' do
-      sample_files = Dir['test/samples/**/*.rb'].reject { |f| File.zero?(f) }
-      create_analysed_modules_collection
-      generate_report
-      lines = File.readlines('test/samples/lint.txt').map(&:strip).reject(&:empty?)
-      analysed_files = lines.map { |line| line.split(':').first }.uniq
-      assert_matched_arrays analysed_files, sample_files
-    end
-  end
-
-  def create_analysed_modules_collection
-    RubyCritic::Config.root = 'test/samples'
-    RubyCritic::Config.source_control_system = RubyCritic::SourceControlSystem::Git.new
-    analyser_runner = RubyCritic::AnalysersRunner.new('test/samples/')
-    @analysed_modules_collection = analyser_runner.run
-  end
-
-  def generate_report
-    report = RubyCritic::Generator::LintReport.new(@analysed_modules_collection)
-    report.generate_report
-  end
-end

data/test/lib/rubycritic/generators/turbulence_test.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-require 'test_helper'
-require 'rubycritic/generators/html/turbulence'
-
-describe RubyCritic::Turbulence do
-  describe '::data' do
-    it 'returns json data that maps pathname, churn and complexity to name, x and y' do
-      files = [AnalysedModuleDouble.new(name: 'Foo', churn: 1, complexity: 2)]
-      turbulence_data = RubyCritic::Turbulence.data(files)
-      instance_parsed_json = JSON.parse(turbulence_data).first
-      instance_parsed_json['name'].must_equal 'Foo'
-      instance_parsed_json['x'].must_equal 1
-      instance_parsed_json['y'].must_equal 2
-    end
-  end
-end
-
-class AnalysedModuleDouble < OpenStruct; end

data/test/lib/rubycritic/generators/view_helpers_test.rb

@@ -1,85 +0,0 @@
-# frozen_string_literal: true
-
-require 'test_helper'
-require 'rubycritic/generators/html/view_helpers'
-require 'pathname'
-
-describe RubyCritic::ViewHelpers do
-  context 'when the file is in the root directory' do
-    let(:generator) { GeneratorDouble.new('foo.html') }
-
-    describe '#file_path' do
-      context 'when the other file is in the same directory' do
-        it 'creates a relative path to a file' do
-          generator.file_path('bar.html').to_s.must_equal 'bar.html'
-        end
-      end
-
-      context 'when the other file is in a subdirectory' do
-        it 'creates a relative path to a file' do
-          generator.file_path('subdirectory/bar.html').to_s.must_equal 'subdirectory/bar.html'
-        end
-      end
-    end
-
-    describe '#asset_path' do
-      it 'creates a relative path to an asset' do
-        generator.asset_path('stylesheets/application.css').to_s
-                 .must_equal 'assets/stylesheets/application.css'
-      end
-    end
-  end
-
-  context 'when the file is n directories deep' do
-    let(:generator) { GeneratorDouble.new('lets/go/crazy/foo.html') }
-
-    describe '#file_path' do
-      context 'when the other file is in the same directory' do
-        it 'creates a relative path to a file' do
-          generator.file_path('lets/go/crazy/bar.html').to_s.must_equal 'bar.html'
-        end
-      end
-
-      context 'when the other file is in the root directory' do
-        it 'creates a relative path to a file' do
-          generator.file_path('bar.html').to_s.must_equal '../../../bar.html'
-        end
-      end
-
-      context 'when the other file has n-1 directories in common' do
-        it 'creates a relative path to a file' do
-          generator.file_path('lets/go/home/bar.html').to_s.must_equal '../home/bar.html'
-        end
-      end
-
-      context 'when the other file is one directory deeper' do
-        it 'creates a relative path to a file' do
-          generator.file_path('lets/go/crazy/everybody/bar.html').to_s.must_equal 'everybody/bar.html'
-        end
-      end
-    end
-
-    describe '#asset_path' do
-      it 'creates a relative path to an asset' do
-        generator.asset_path('stylesheets/application.css').to_s
-                 .must_equal '../../../assets/stylesheets/application.css'
-      end
-    end
-  end
-end
-
-class GeneratorDouble
-  include RubyCritic::ViewHelpers
-
-  def initialize(file)
-    @file = Pathname.new(file)
-  end
-
-  def file_directory
-    root_directory + @file.dirname
-  end
-
-  def root_directory
-    Pathname.new('root_directory')
-  end
-end

data/test/lib/rubycritic/revision_comparator_test.rb

@@ -1,66 +0,0 @@
-# frozen_string_literal: true
-
-require 'test_helper'
-require 'rubycritic/revision_comparator'
-
-describe RubyCritic::RevisionComparator do
-  subject { RubyCritic::RevisionComparator.new([]) }
-
-  describe '#set_statuses' do
-    context 'in a SCS with :revision? == false' do
-      before do
-        RubyCritic::Config.expects(:source_control_system)
-                          .at_least_once
-                          .returns(stub(revision?: false))
-      end
-
-      it 'does not attempt to compare with previous results' do
-        subject.expects(:load_cached_analysed_modules).never
-        result = subject.set_statuses([])
-        result.must_equal([])
-      end
-    end
-
-    context 'in a SCS with :revision? == true' do
-      before do
-        RubyCritic::Config.expects(:source_control_system)
-                          .at_least_once
-                          .returns(stub(revision?: true))
-      end
-
-      context 'without previously cached results' do
-        before do
-          subject.expects(:revision_file).returns('foo')
-          File.expects(:file?).with('foo').returns(false)
-        end
-
-        it 'does not load them' do
-          RubyCritic::Serializer.expects(:new).never
-          subject.set_statuses([])
-        end
-
-        it 'does not invoke RubyCritic::SmellsStatusSetter' do
-          RubyCritic::SmellsStatusSetter.expects(:set).never
-          subject.set_statuses([])
-        end
-      end
-
-      context 'with previously cached results' do
-        before do
-          subject.expects(:revision_file).twice.returns('foo')
-          File.expects(:file?).with('foo').returns(true)
-          RubyCritic::Serializer.expects(:new).with('foo').returns(stub(load: []))
-        end
-
-        it 'loads them' do
-          subject.set_statuses([])
-        end
-
-        it 'invokes RubyCritic::SmellsStatusSetter' do
-          RubyCritic::SmellsStatusSetter.expects(:set).once
-          subject.set_statuses([])
-        end
-      end
-    end
-  end
-end