ruby-watchr 0.1.9 → 0.2.0

data/lib/watchr/analysers/reek.rb

@@ -1,4 +1,4 @@
-require 'watchr/smell'
+require 'watchr/smell_builder'
 
 module Watchr
   module Analysers
@@ -6,18 +6,22 @@ module Watchr
       include SmellTypes
 
       def analyse_reek(report)
-        report.smells.each do |smell|
-          location = Location.new(
-            smell.location['source'], 
-            smell.location['lines'].first
+        report.smells.each do |reek_smell|
+          location = reek_smell.location
+          smell = reek_smell.smell
+
+          builder = Watchr::SmellBuilder.new(
+            underscore(smell['subclass']).to_sym, 
+            location['context'], 
+            smell['message'], 
+          )
+
+          builder.add_location(
+            location['source'], 
+            location['lines'].first
           )
 
-          add_smell(Watchr::Smell.new(
-            underscore(smell.smell['subclass']).to_sym, 
-            smell.location['context'], 
-            smell.smell['message'], 
-            location
-          ))
+          add_smell(builder.smell)
         end
       end
 

data/lib/watchr/smell.rb

@@ -4,14 +4,11 @@ module Watchr
   class Smell
     include SmellTypes
 
-    def initialize(type, context, description, locations, details = {})
+    def initialize(type, context, description)
       @type = type
       @context = context
       @description = description
       @locations = []
-      @details = details
-
-      Array(locations).each {|l| add_location(l)}
     end
 
     def type
@@ -34,6 +31,10 @@ module Watchr
       @details
     end
 
+    def details=(details)
+      @details = details
+    end
+
     def add_location(location)
       @locations << location
     end

data/lib/watchr/smell_builder.rb

@@ -0,0 +1,31 @@
+require 'watchr/smell'
+require 'watchr/smell_types'
+
+module Watchr
+  class SmellBuilder
+    include SmellTypes
+
+    attr_reader :smell
+
+    def initialize(type, context, description)
+      assert_smell_type(type)
+
+      @smell = Smell.new(type, context, description)
+    end
+
+    def add_location(file, line)
+      @smell.add_location(Location.new(file, line))
+    end
+
+    def add_details(details)
+      @smell.details = details
+    end
+
+    private
+
+    def assert_smell_type(type)
+      raise "Invalid smell type '#{type}'" \
+        unless ALL_SMELLS.include?(type)
+    end
+  end
+end

data/lib/watchr/version.rb

@@ -1,3 +1,3 @@
 module Watchr
-  VERSION = "0.1.9"
+  VERSION = "0.2.0"
 end

data/spec/watchr/analysers/reek_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+require 'watchr/analysers/reek'
+
+describe Watchr::Analysers::Reek do
+  let(:analyse) { 
+    analyse = stub('analyse', :add_smell => true)
+    analyse.extend Watchr::Analysers::Reek
+
+    analyse
+  }
+
+  describe '#analyse_reek' do
+    subject { analyse.analyse_reek(report) }
+
+    let(:reek_smell) { stub('smell',
+      :smell => {
+        'subclass' => 'BooleanParameter',
+        'message' => 'message'
+      },
+
+      :location => {
+        'context' => 'context',
+        'lines' => [12],
+        'source' => 'source.rb' 
+      })
+    }
+
+    let(:reek_smells) { [reek_smell] }
+
+    let(:report) { stub('report', :smells => reek_smells) }
+
+    let(:smell) { stub('smell', :add_location => true) }
+
+    it 'should add smell for each reek report smell' do
+      Watchr::Smell.expects(:new).with(:boolean_parameter, 'context', 'message').returns(smell)
+
+      analyse.expects(:add_smell).returns(smell)
+
+      subject
+    end
+  end
+end

data/spec/watchr/smell_builder_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+require 'watchr/smell_builder'
+
+describe Watchr::SmellBuilder do
+  context 'invalid smell type' do
+    subject { Watchr::SmellBuilder.new(:foo, '', '') }
+    
+    it { lambda { subject }.should raise_error "Invalid smell type 'foo'" }
+  end
+end

data/spec/watchr/smell_spec.rb

@@ -7,15 +7,13 @@ describe Watchr::Smell do
 
   let(:location) { 'location' }
 
-  let(:locations) { location }
-
   let(:description) { 'description' }
 
   let(:context) { 'context' }
 
   let(:details) { stub('details') }
 
-  let(:smell) { Watchr::Smell.new(type, context, description, locations, details) }
+  let(:smell) { Watchr::Smell.new(type, context, description) }
 
   subject { smell }
 
@@ -26,12 +24,14 @@ describe Watchr::Smell do
   describe '#locations' do
     subject { smell.locations }
 
+    before { smell.add_location(location) }
+
     context 'one location' do
       it { should == [location] }
     end
 
     context 'multiple locations' do
-      let(:locations) { [location, location] }
+      before { smell.add_location(location) }
 
       it { should == [location, location] }
     end
@@ -39,7 +39,17 @@ describe Watchr::Smell do
 
   its(:description) { should == description }
 
-  its(:details) { should == details }
+  describe '#details' do
+    context 'without any' do
+      its(:details) { should == nil }
+    end
+
+    context 'with given' do
+      before { smell.details = details }
+
+      its(:details) { should == details }
+    end
+  end
 
   its(:context) { should == context }
 end

data/spec/watchr/smells_collector_spec.rb

@@ -37,6 +37,4 @@ describe Watchr::SmellsCollector do
       it { should be_false }
     end
   end
-
-
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 9
-  version: 0.1.9
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Petr Janda
@@ -101,6 +101,7 @@ files:
 - lib/watchr/paths.rb
 - lib/watchr/rating.rb
 - lib/watchr/smell.rb
+- lib/watchr/smell_builder.rb
 - lib/watchr/smell_types.rb
 - lib/watchr/smells_collector.rb
 - lib/watchr/version.rb
@@ -109,12 +110,14 @@ files:
 - spec/spec_helper.rb
 - spec/watchr/analyse_spec.rb
 - spec/watchr/analysers/flog_spec.rb
+- spec/watchr/analysers/reek_spec.rb
 - spec/watchr/file_analyse_spec.rb
 - spec/watchr/location_spec.rb
 - spec/watchr/metrics/flay/report_spec.rb
 - spec/watchr/metrics/flog/flog_report_spec.rb
 - spec/watchr/paths_spec.rb
 - spec/watchr/rating_spec.rb
+- spec/watchr/smell_builder_spec.rb
 - spec/watchr/smell_spec.rb
 - spec/watchr/smells_collector_spec.rb
 - watchr.gemspec
@@ -156,11 +159,13 @@ test_files:
 - spec/spec_helper.rb
 - spec/watchr/analyse_spec.rb
 - spec/watchr/analysers/flog_spec.rb
+- spec/watchr/analysers/reek_spec.rb
 - spec/watchr/file_analyse_spec.rb
 - spec/watchr/location_spec.rb
 - spec/watchr/metrics/flay/report_spec.rb
 - spec/watchr/metrics/flog/flog_report_spec.rb
 - spec/watchr/paths_spec.rb
 - spec/watchr/rating_spec.rb
+- spec/watchr/smell_builder_spec.rb
 - spec/watchr/smell_spec.rb
 - spec/watchr/smells_collector_spec.rb