ruby-watchr 0.0.1 → 0.1.0

data/lib/watchr/analysers/flog.rb

@@ -0,0 +1,61 @@
+require 'watchr/smell'
+
+module Watchr
+  module Analysers
+    module Flog
+      include SmellTypes
+
+      VERY_COMPLEX_OBJECT_THRESHOLD = 100
+
+      COMPLEX_OBJECT_THRESHOLD = 50
+
+      VERY_COMPLEX_METHOD_THRESHOLD = 40
+
+      COMPLEX_METHOD_THRESHOLD = 20
+
+      def analyse_flog(report)
+        report.classes.each do |klass|
+          analyse_class_complexity(klass)
+
+          klass.methods.each do |method|
+            analyse_method_complexity(method)
+          end
+        end
+      end
+
+      protected
+
+      def analyse_class_complexity(klass)
+        analyse_complexity(klass, :object)
+      end
+
+      def analyse_method_complexity(method)
+        analyse_complexity(method, :method)
+      end
+
+      def analyse_complexity(target, type)
+        add_smell(
+          Watchr::Smell.new(
+            get_smell_level?(target, type),
+            target.name, '', target.location, {:score => target.total_score}
+          )
+        ) if target.total_score >= get_threshold(:complex, type.upcase)
+      end
+
+      def get_smell_level?(target, type)
+        threshold = get_threshold(:very_complex, type)
+        complexity = target.total_score >= threshold ? :very_complex : :complex
+
+        get_smell_type(complexity, type.upcase)
+      end
+
+      def get_threshold(complexity, type)
+        Watchr::Analysers::Flog.const_get("#{complexity.upcase}_#{type.upcase}_THRESHOLD")
+      end
+
+      def get_smell_type(complexity, type)
+        Watchr::SmellTypes.const_get("#{complexity.upcase}_#{type.upcase}")
+      end
+    end
+  end
+end

data/lib/watchr/file_analyse.rb

@@ -2,6 +2,8 @@ require 'watchr/flog_metric/report'
 require 'watchr/smell'
 require 'watchr/smells_collector'
 
+require 'watchr/analysers/flog'
+
 module Watchr
   #
   # Analyse for one given file. All the different metric analyse data are
@@ -9,6 +11,7 @@ module Watchr
   # improvements.
   #
   class FileAnalyse
+    include Analysers::Flog
 
     attr_reader :path
 
@@ -21,30 +24,7 @@ module Watchr
       @path = path
       @smells = SmellsCollector.new
 
-      flog_metric = FlogMetric::Report.new([path])
-      flog_metric.classes.each do |klass|
-        if klass.total_score > 150
-          @smells.add(
-            Smell.new(
-              Smell::VERY_COMPLEX_OBJECT,
-              klass.name,
-              [klass.location],
-              klass.total_score
-            )
-          )
-        end
-
-        if klass.total_score > 50
-          @smells.add(
-            Smell.new(
-              Smell::COMPLEX_OBJECT,
-              klass.name,
-              [klass.location],
-              klass.total_score
-            )
-          )
-        end
-      end
+      analyse_flog(FlogMetric::Report.new([path]))
     end
 
     def smelly?
@@ -55,7 +35,7 @@ module Watchr
     # Store the flay report, which was evaluated on global basis
     # to check for duplications across multiple files.
     #
-    # @param {Array.<Watchr::FlayMetric::Diff>} Duplication details.
+    # @param {Array<Watchr::FlayMetric::Diff>} Duplication details.
     # @return nil
     #
     def flay(report)
@@ -65,5 +45,9 @@ module Watchr
     def smells
       @smells.all
     end
+
+    def add_smell(smell)
+      @smells.add(smell)
+    end
   end
 end

data/lib/watchr/smell.rb

@@ -1,41 +1,15 @@
+require 'watchr/smell_types'
+
 module Watchr
   class Smell
+    include SmellTypes
 
-    #
-    # Method complexity is high.
-    #
-    COMPLEX_METHOD = :complex_method
-
-    #
-    # Method complexity is very high.
-    #
-    VERY_COMPLEX_METHOD = :very_complex_method
-
-    #
-    # Object (class / module) total complexity is high.
-    #
-    COMPLEX_OBJECT = :complex_object
-
-    #
-    # Object (class / module) total complexity is very high.
-    #
-    VERY_COMPLEX_OBJECT = :very_complex_object
-
-    #
-    # Code in multiple places is identical.
-    #
-    IDENTICAL_CODE = :identical_code
-
-    #
-    # Code in multiple places is similar (not identical).
-    #
-    SIMILAR_CODE = :similar_code
-
-    def initialize(type, context, description, locations)
+    def initialize(type, context, description, locations, options)
       @type = type
       @context = context
       @description = description
       @locations = []
+      @options = options
 
       Array(locations).each {|l| add_location(l)}
     end
@@ -56,6 +30,10 @@ module Watchr
       @context
     end
 
+    def options
+      @options
+    end
+
     def add_location(location)
       @locations << location
     end

data/lib/watchr/smell_types.rb

@@ -0,0 +1,33 @@
+module Watchr
+  module SmellTypes
+    #
+    # Method complexity is high.
+    #
+    COMPLEX_METHOD = :complex_method
+
+    #
+    # Method complexity is very high.
+    #
+    VERY_COMPLEX_METHOD = :very_complex_method
+
+    #
+    # Object (class / module) total complexity is high.
+    #
+    COMPLEX_OBJECT = :complex_object
+
+    #
+    # Object (class / module) total complexity is very high.
+    #
+    VERY_COMPLEX_OBJECT = :very_complex_object
+
+    #
+    # Code in multiple places is identical.
+    #
+    IDENTICAL_CODE = :identical_code
+
+    #
+    # Code in multiple places is similar (not identical).
+    #
+    SIMILAR_CODE = :similar_code
+  end
+end

data/lib/watchr/version.rb

@@ -1,3 +1,3 @@
 module Watchr
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/watchr.rb

@@ -1,7 +1,4 @@
 require "watchr/version"
-require 'watchr/flay_metric/report'
-require 'watchr/flog_metric/report'
-require 'watchr/paths'
 require 'watchr/analyse'
 
 module Watchr

data/spec/watchr/analysers/flog_spec.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+require 'watchr/analysers/flog'
+
+describe Watchr::Analysers::Flog do
+  let(:analyse) { 
+    analyse = stub('analyse', :add_smell => true)
+    analyse.extend Watchr::Analysers::Flog
+
+    analyse
+  }
+
+  let(:method) { stub('method',
+    :name => 'method',
+    :location => stub('location'),
+    :total_score => 10) 
+  }
+
+  let(:complex_method) { stub('method',
+    :name => 'complex_method',
+    :location => stub('location'),
+    :total_score => 30)
+  }
+
+  let(:very_complex_method) { stub('method',
+    :name => 'very_complex_method',
+    :location => stub('location'),
+    :total_score => 100)
+  }
+
+  let(:clazz) { stub('class',
+    :name => 'Class',
+    :location => stub('location'),
+    :total_score => 100,
+    :methods => [method, complex_method, very_complex_method])
+  }
+  
+  let(:classes) { [clazz] }
+
+  let(:report) { stub('report', :classes => classes) }
+
+  subject { analyse.analyse_flog(report) }
+
+  describe '#analyse_flog' do
+    let(:smell) { stub('smell') }
+
+    before { Watchr::Smell.stubs(:new).returns(smell) }
+
+    it 'should add smell for complex method' do
+      Watchr::Smell.expects(:new).with(
+        Watchr::Smell::COMPLEX_METHOD,
+        complex_method.name,
+        '',
+        complex_method.location,
+        { :score => complex_method.total_score }
+      )
+
+      analyse.expects(:add_smell).returns(smell)
+
+      subject
+    end
+
+    it 'should add smell for very complex method' do
+      Watchr::Smell.expects(:new).with(
+        Watchr::Smell::VERY_COMPLEX_METHOD,
+        very_complex_method.name,
+        '',
+        very_complex_method.location,
+        { :score => very_complex_method.total_score }
+      )
+
+      analyse.expects(:add_smell).returns(smell)
+
+      subject
+    end
+
+    it 'should add smell for very complex object' do
+      Watchr::Smell.expects(:new).with(
+        Watchr::Smell::VERY_COMPLEX_OBJECT,
+        clazz.name,
+        '',
+        clazz.location,
+        { :score => clazz.total_score }
+      )
+
+      analyse.expects(:add_smell).returns(smell)
+
+      subject
+    end
+  end
+end

data/spec/watchr/file_analyse_spec.rb

@@ -2,6 +2,9 @@ require 'spec_helper'
 require 'watchr/file_analyse'
 
 describe Watchr::FileAnalyse do
+
+  it { Watchr::FileAnalyse.ancestors.should include(Watchr::Analysers::Flog) }
+
   let(:path) { 'spec/fixtures/class.rb' }
 
   let(:file_analyse) { Watchr::FileAnalyse.new(path) }

data/spec/watchr/smell_spec.rb

@@ -13,7 +13,9 @@ describe Watchr::Smell do
 
   let(:context) { 'context' }
 
-  let(:smell) { Watchr::Smell.new(type, context, description, locations) }
+  let(:options) { stub('options') }
+
+  let(:smell) { Watchr::Smell.new(type, context, description, locations, options) }
 
   subject { smell }
 
@@ -35,11 +37,9 @@ describe Watchr::Smell do
     end
   end
 
-  describe '#description' do
-    its(:description) { should == description }
-  end
+  its(:description) { should == description }
 
-  describe '#context' do
-    its(:context) { should == context }
-  end
+  its(:options) { should == options }
+
+  its(:context) { should == context }
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Petr Janda
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-07-05 00:00:00 +02:00
+date: 2012-07-06 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -73,6 +73,7 @@ files:
 - Rakefile
 - lib/watchr.rb
 - lib/watchr/analyse.rb
+- lib/watchr/analysers/flog.rb
 - lib/watchr/file_analyse.rb
 - lib/watchr/flay_metric/diff.rb
 - lib/watchr/flay_metric/report.rb
@@ -82,12 +83,14 @@ files:
 - lib/watchr/location.rb
 - lib/watchr/paths.rb
 - lib/watchr/smell.rb
+- lib/watchr/smell_types.rb
 - lib/watchr/smells_collector.rb
 - lib/watchr/version.rb
 - spec/fixtures/class.rb
 - spec/fixtures/module.rb
 - spec/spec_helper.rb
 - spec/watchr/analyse_spec.rb
+- spec/watchr/analysers/flog_spec.rb
 - spec/watchr/file_analyse_spec.rb
 - spec/watchr/flay/report_spec.rb
 - spec/watchr/flog_metric/flog_matric/flog_report_spec.rb
@@ -133,6 +136,7 @@ test_files:
 - spec/fixtures/module.rb
 - spec/spec_helper.rb
 - spec/watchr/analyse_spec.rb
+- spec/watchr/analysers/flog_spec.rb
 - spec/watchr/file_analyse_spec.rb
 - spec/watchr/flay/report_spec.rb
 - spec/watchr/flog_metric/flog_matric/flog_report_spec.rb