[Mezuro] Refactored base_tool and native_metric entities/clients to model

João M. M. da Silva + Diego Araújo · Paulo Meireles
1 parent 8d1ac533
Showing 21 changed files with 127 additions and 275 deletions Show diff stats
plugins/mezuro/controllers/mezuro_plugin_myprofile_controller.rb
plugins/mezuro/lib/kalibro/base_tool.rb
plugins/mezuro/lib/kalibro/client/base_tool_client.rb
plugins/mezuro/lib/kalibro/client/project_client.rb
plugins/mezuro/lib/kalibro/entities/base_tool.rb
plugins/mezuro/lib/kalibro/entities/metric.rb
plugins/mezuro/lib/kalibro/entities/native_metric.rb
plugins/mezuro/lib/kalibro/entities/project.rb
plugins/mezuro/lib/kalibro/entities/repository.rb
plugins/mezuro/lib/kalibro/metric.rb
plugins/mezuro/lib/kalibro/model.rb
plugins/mezuro/lib/kalibro/native_metric.rb
plugins/mezuro/lib/kalibro/project.rb
plugins/mezuro/test/fixtures/base_tool_fixtures.rb
plugins/mezuro/test/fixtures/native_metric_fixtures.rb
plugins/mezuro/test/unit/kalibro/base_tool_test.rb
plugins/mezuro/test/unit/kalibro/client/base_tool_client_test.rb
plugins/mezuro/test/unit/kalibro/entities/base_tool_test.rb
plugins/mezuro/test/unit/kalibro/entities/metric_test.rb
plugins/mezuro/test/unit/kalibro/entities/native_metric_test.rb
@@ -5,18 +5,18 @@ class MezuroPluginMyprofileController &lt; ProfileController
   def choose_base_tool
     @configuration_content = profile.articles.find(params[:id])
-    @base_tools = Kalibro::Client::BaseToolClient.base_tools
+    @base_tools = Kalibro::BaseTool.all_names
   end
   def choose_metric
     @configuration_content = profile.articles.find(params[:id])
     @base_tool = params[:base_tool]
-    @supported_metrics = Kalibro::Client::BaseToolClient.metrics @base_tool
+    @supported_metrics = Kalibro::BaseTool.find_by_name(@base_tool).supported_metrics
   end
   def new_metric_configuration
     @configuration_content = profile.articles.find(params[:id])
-    @metric = Kalibro::Client::BaseToolClient.metric params[:metric_name], params[:base_tool]
+    @metric = Kalibro::BaseTool.find_by_name(params[:base_tool]).metric params[:metric_name]
   end
   def new_compound_metric_configuration
@@ -123,7 +123,7 @@ class MezuroPluginMyprofileController &lt; ProfileController
   def new_metric_configuration_instance
     metric_configuration = Kalibro::Entities::MetricConfiguration.new
-    metric_configuration.metric = Kalibro::Entities::NativeMetric.new
+    metric_configuration.metric = Kalibro::NativeMetric.new
     assign_metric_configuration_instance(metric_configuration, Kalibro::Entities::MetricConfiguration::NATIVE_TYPE)
   end
@@ -0,0 +1,29 @@
+class Kalibro::BaseTool < Kalibro::Model
+
+  attr_accessor :name, :description, :supported_metric
+
+  def self.all_names
+    request("BaseTool", :get_base_tool_names)[:base_tool_name].to_a
+  end
+
+  def self.find_by_name(name)
+    new request("BaseTool", :get_base_tool, {:base_tool_name => name})[:base_tool]
+  end
+
+  def supported_metric=(value)
+    @supported_metric = to_objects_array(value, Kalibro::NativeMetric)
+  end
+
+  def supported_metrics
+    @supported_metric
+  end
+
+  def supported_metrics=(supported_metrics)
+    @supported_metric = supported_metrics
+  end
+
+  def metric(name)
+    supported_metrics.find {|metric| metric.name == name}
+  end
+
+end
@@ -1,28 +0,0 @@
-class Kalibro::Client::BaseToolClient
-  
-  def self.base_tools
-    new.base_tool_names
-  end
-  
-  def self.metrics(base_tool)
-    new.base_tool(base_tool).supported_metrics
-  end
-  
-  def self.metric(metric_name, base_tool)
-    metrics(base_tool).find {|metric| metric.name == metric_name}
-  end
-  
-  def initialize
-    @port = Kalibro::Client::Port.new('BaseTool')
-  end
-
-  def base_tool_names
-    @port.request(:get_base_tool_names)[:base_tool_name].to_a
-  end
-
-  def base_tool(name)
-    hash = @port.request(:get_base_tool, {:base_tool_name => name})[:base_tool]
-    Kalibro::Entities::BaseTool.from_hash(hash)
-  end
-
-end
@@ -1,65 +0,0 @@
-class Kalibro::Client::ProjectClient
-
-  def self.project(project_name)
-    new.project(project_name)
-  end
-
-  def self.save(project_content)
-    project = create_project(project_content)
-    new.save(project)
-  end
-
-  def self.remove(project_name)
-    instance = new
-    if (instance.project_names.include?(project_name))
-      instance.remove(project_name)
-    end
-  end
-
-  def self.create_project (project_content)
-    project = Kalibro::Entities::Project.new
-    project.name = project_content.name
-    project.license = project_content.license
-    project.description = project_content.description
-    project.repository = create_repository(project_content)
-    project.configuration_name = project_content.configuration_name
-    project
-  end
-
-  def self.create_repository(project_content)
-    repository = Kalibro::Entities::Repository.new
-    repository.type = project_content.repository_type
-    repository.address = project_content.repository_url
-    repository
-  end
-  
-  def initialize
-    @port = Kalibro::Client::Port.new('Project')
-  end
-
-  def save(project)
-    @port.request(:save_project, {:project => project.to_hash})
-  end
-
-  def project_names
-    @port.request(:get_project_names)[:project_name].to_a
-  end
-
-  def project(project_name)
-    begin 
-      hash = @port.request(:get_project, {:project_name => project_name})[:project]
-    rescue Exception => error
-      unless (error.message =~ /There is no project named/).nil?
-        return nil
-      else
-        raise error
-      end
-    end
-    Kalibro::Entities::Project.from_hash(hash)
-  end
-
-  def remove(project_name)
-    @port.request(:remove_project, {:project_name => project_name})
-  end
-
-end
@@ -1,17 +0,0 @@
-class Kalibro::Entities::BaseTool < Kalibro::Entities::Entity
-  
-  attr_accessor :name, :description, :supported_metric
-
-  def supported_metric=(value)
-    @supported_metric = to_entity_array(value, Kalibro::Entities::NativeMetric)
-  end
-  
-  def supported_metrics
-    @supported_metric
-  end
-
-  def supported_metrics=(supported_metrics)
-    @supported_metric = supported_metrics
-  end
-
-end
 \ No newline at end of file
@@ -1,5 +0,0 @@
-class Kalibro::Entities::Metric < Kalibro::Entities::Entity
-  
-  attr_accessor :name, :scope, :description
-
-end
@@ -1,17 +0,0 @@
-class Kalibro::Entities::NativeMetric < Kalibro::Entities::Metric
-
-  attr_accessor :origin, :language
-
-  def languages
-    @language
-  end
-
-  def languages=(languages)
-    @language = languages
-  end
-
-  def language=(value)
-    @language = to_entity_array(value)
-  end
-
-end
@@ -1,12 +0,0 @@
-class Kalibro::Entities::Project < Kalibro::Entities::Entity
-
-	attr_accessor :name, :license, :description, :repository, :configuration_name, :state, :error
-
-  def repository=(value)
-    @repository = to_entity(value, Kalibro::Entities::Repository)
-  end
-
-  def error=(value)
-    @error = to_entity(value, Kalibro::Entities::Error)
-  end
-end
@@ -1,5 +0,0 @@
-class Kalibro::Entities::Repository < Kalibro::Entities::Entity
-  
-  attr_accessor :type, :address, :username, :password
-
-end
 \ No newline at end of file
@@ -0,0 +1,5 @@
+class Kalibro::Metric < Kalibro::Model
+  
+  attr_accessor :name, :scope, :description
+
+end
@@ -27,6 +27,7 @@ class Kalibro::Model
   def convert_to_hash(value)  
     return value if value.nil?
+    return value.collect { |element| convert_to_hash(element) } if value.is_a?(Array)
     return value.to_hash if value.is_a?(Kalibro::Model)
     value
   end
@@ -48,4 +49,13 @@ class Kalibro::Model
     response.to_hash["#{action}_response".to_sym]
   end
+  def to_objects_array(value, model_class = nil)
+    array = value.kind_of?(Array) ? value : [value]
+    array.each.collect { |element| to_object(element, model_class) }
+  end
+
+  def to_object(value, model_class)
+    value.kind_of?(Hash) ? model_class.new(value) : value
+  end 
+
 end
@@ -0,0 +1,17 @@
+class Kalibro::NativeMetric < Kalibro::Metric
+
+  attr_accessor :origin, :language
+
+  def languages
+    @language
+  end
+
+  def languages=(languages)
+    @language = languages
+  end
+
+  def language=(value)
+    @language = to_objects_array(value)
+  end
+
+end
@@ -42,7 +42,7 @@ class Kalibro::Project &lt; Kalibro::Model
   end
   def repository=(value)
-    @repository = (value.kind_of?(Hash)) ? Kalibro::Repository.new(value) : value
+    @repository = to_object(value, Kalibro::Repository)
   end
 end
@@ -2,16 +2,11 @@ require File.dirname(__FILE__) + &#39;/native_metric_fixtures&#39;
 class BaseToolFixtures
-  def self.analizo
-    base_tool = Kalibro::Entities::BaseTool.new
-    base_tool.name = 'Analizo'
-    base_tool.supported_metrics = [
-      NativeMetricFixtures.total_cof,
-      NativeMetricFixtures.amloc]
-    base_tool
+  def self.base_tool
+    Kalibro::BaseTool.new base_tool_hash
   end
-  def self.analizo_hash
+  def self.base_tool_hash
     {:name => 'Analizo', :supported_metric => [
         NativeMetricFixtures.total_cof_hash,
         NativeMetricFixtures.amloc_hash]}
 class NativeMetricFixtures
   def self.total_cof
-    total_cof = Kalibro::Entities::NativeMetric.new
-    total_cof.name = 'Total Coupling Factor'
-    total_cof.scope = 'APPLICATION'
-    total_cof.origin = 'Analizo'
-    total_cof.languages = ['JAVA']
-    total_cof
+    Kalibro::NativeMetric.new total_cof_hash
   end
   def self.total_cof_hash
@@ -14,12 +9,7 @@ class NativeMetricFixtures
   end
   def self.amloc
-    total_cof = Kalibro::Entities::NativeMetric.new
-    total_cof.name = 'Average Method LOC'
-    total_cof.scope = 'CLASS'
-    total_cof.origin = 'Analizo'
-    total_cof.languages = ['JAVA']
-    total_cof
+    Kalibro::NativeMetric.new amloc_hash
   end
   def self.amloc_hash
@@ -0,0 +1,36 @@
+require "test_helper"
+
+require "#{RAILS_ROOT}/plugins/mezuro/test/fixtures/base_tool_fixtures"
+
+class BaseToolTest < ActiveSupport::TestCase
+
+  def setup
+    @hash = BaseToolFixtures.base_tool_hash
+    @base_tool = BaseToolFixtures.base_tool
+  end
+
+  should 'create base tool from hash' do
+    assert_equal @base_tool.name, Kalibro::BaseTool.new(@hash).name
+  end
+
+  should 'convert base tool to hash' do
+    assert_equal @hash, @base_tool.to_hash
+  end
+
+  should 'get base tool names' do
+    names = ['Analizo', 'Checkstyle']
+    Kalibro::BaseTool.expects(:request).with("BaseTool", :get_base_tool_names).returns({:base_tool_name => names})
+    assert_equal names, Kalibro::BaseTool.all_names
+  end
+
+  should 'get base tool by name' do
+    request_body = {:base_tool_name => @base_tool.name}
+    Kalibro::BaseTool.expects(:request).with("BaseTool", :get_base_tool, request_body).returns({:base_tool => @hash})
+    assert_equal @base_tool.name, Kalibro::BaseTool.find_by_name(@base_tool.name).name
+  end
+  
+  should 'get base tool metrics' do
+    assert_equal @base_tool.supported_metrics[0].name, @base_tool.metric('Total Coupling Factor').name
+  end
+  
+end
@@ -1,37 +0,0 @@
-require "test_helper"
-
-require "#{RAILS_ROOT}/plugins/mezuro/test/fixtures/base_tool_fixtures"
-
-class BaseToolClientTest < ActiveSupport::TestCase
-
-  def setup
-    @port = mock
-    Kalibro::Client::Port.expects(:new).with('BaseTool').returns(@port)
-    @client = Kalibro::Client::BaseToolClient.new
-  end
-
-  should 'get base tool names (zero)' do
-    @port.expects(:request).with(:get_base_tool_names).returns({})
-    assert_equal [], @client.base_tool_names
-  end
-
-  should 'get base tool names (one)' do
-    name = 'Analizo'
-    @port.expects(:request).with(:get_base_tool_names).returns({:base_tool_name => name})
-    assert_equal [name], @client.base_tool_names
-  end
-
-  should 'get base tool names' do
-    names = ['Analizo', 'Checkstyle']
-    @port.expects(:request).with(:get_base_tool_names).returns({:base_tool_name => names})
-    assert_equal names, @client.base_tool_names
-  end
-
-  should 'get base tool by name' do
-    analizo = BaseToolFixtures.analizo
-    request_body = {:base_tool_name => 'Analizo'}
-    @port.expects(:request).with(:get_base_tool, request_body).returns({:base_tool => analizo.to_hash})
-    assert_equal analizo, @client.base_tool('Analizo')
-  end
-
-end
 \ No newline at end of file
@@ -1,20 +0,0 @@
-require "test_helper"
-
-require "#{RAILS_ROOT}/plugins/mezuro/test/fixtures/base_tool_fixtures"
-
-class BaseToolTest < ActiveSupport::TestCase
-
-  def setup
-    @hash = BaseToolFixtures.analizo_hash
-    @base_tool = BaseToolFixtures.analizo
-  end
-
-  should 'create base tool from hash' do
-    assert_equal @base_tool, Kalibro::Entities::BaseTool.from_hash(@hash)
-  end
-
-  should 'convert base tool to hash' do
-    assert_equal @hash, @base_tool.to_hash
-  end
-
-end
 \ No newline at end of file
@@ -1,24 +0,0 @@
-require "test_helper"
-
-class MetricTest < ActiveSupport::TestCase
-  
-  def setup
-    name = 'MetricTest metric'
-    scope = 'METHOD'
-    description = 'Metric created for testing'
-    @hash = {:name => name, :scope => scope, :description => description}
-    @metric = Kalibro::Entities::Metric.new
-    @metric.name = name
-    @metric.scope = scope
-    @metric.description = description
-  end
-
-  should 'create metric from hash' do
-    assert_equal @metric, Kalibro::Entities::Metric.from_hash(@hash)
-  end
-
-  should 'convert metric to hash' do
-    assert_equal @hash, @metric.to_hash
-  end
-
-end
 \ No newline at end of file
@@ -1,20 +0,0 @@
-require "test_helper"
-
-require "#{RAILS_ROOT}/plugins/mezuro/test/fixtures/native_metric_fixtures"
-
-class NativeMetricTest < ActiveSupport::TestCase
-
-  def setup
-    @hash = NativeMetricFixtures.amloc_hash
-    @metric = NativeMetricFixtures.amloc
-  end
-
-  should 'create native metric from hash' do
-    assert_equal @metric, Kalibro::Entities::NativeMetric.from_hash(@hash)
-  end
-
-  should 'convert native metric to hash' do
-    assert_equal @hash, @metric.to_hash
-  end
-
-end
 \ No newline at end of file
@@ -0,0 +1,20 @@
+require "test_helper"
+
+require "#{RAILS_ROOT}/plugins/mezuro/test/fixtures/native_metric_fixtures"
+
+class NativeMetricTest < ActiveSupport::TestCase
+
+  def setup
+    @hash = NativeMetricFixtures.amloc_hash
+    @metric = NativeMetricFixtures.amloc
+  end
+
+  should 'create native metric from hash' do
+    assert_equal @hash[:name], Kalibro::NativeMetric.new(@hash).name
+  end
+
+  should 'convert native metric to hash' do
+    assert_equal @hash, @metric.to_hash
+  end
+
+end
	@@ -5,18 +5,18 @@ class MezuroPluginMyprofileController < ProfileController		@@ -5,18 +5,18 @@ class MezuroPluginMyprofileController < ProfileController
5		5
6	def choose_base_tool	6	def choose_base_tool
7	@configuration_content = profile.articles.find(params[:id])	7	@configuration_content = profile.articles.find(params[:id])
8	- @base_tools = Kalibro::Client::BaseToolClient.base_tools	8	+ @base_tools = Kalibro::BaseTool.all_names
9	end	9	end
10		10
11	def choose_metric	11	def choose_metric
12	@configuration_content = profile.articles.find(params[:id])	12	@configuration_content = profile.articles.find(params[:id])
13	@base_tool = params[:base_tool]	13	@base_tool = params[:base_tool]
14	- @supported_metrics = Kalibro::Client::BaseToolClient.metrics @base_tool	14	+ @supported_metrics = Kalibro::BaseTool.find_by_name(@base_tool).supported_metrics
15	end	15	end
16		16
17	def new_metric_configuration	17	def new_metric_configuration
18	@configuration_content = profile.articles.find(params[:id])	18	@configuration_content = profile.articles.find(params[:id])
19	- @metric = Kalibro::Client::BaseToolClient.metric params[:metric_name], params[:base_tool]	19	+ @metric = Kalibro::BaseTool.find_by_name(params[:base_tool]).metric params[:metric_name]
20	end	20	end
21		21
22	def new_compound_metric_configuration	22	def new_compound_metric_configuration
	@@ -123,7 +123,7 @@ class MezuroPluginMyprofileController < ProfileController		@@ -123,7 +123,7 @@ class MezuroPluginMyprofileController < ProfileController
123		123
124	def new_metric_configuration_instance	124	def new_metric_configuration_instance
125	metric_configuration = Kalibro::Entities::MetricConfiguration.new	125	metric_configuration = Kalibro::Entities::MetricConfiguration.new
126	- metric_configuration.metric = Kalibro::Entities::NativeMetric.new	126	+ metric_configuration.metric = Kalibro::NativeMetric.new
127	assign_metric_configuration_instance(metric_configuration, Kalibro::Entities::MetricConfiguration::NATIVE_TYPE)	127	assign_metric_configuration_instance(metric_configuration, Kalibro::Entities::MetricConfiguration::NATIVE_TYPE)
128	end	128	end
129		129
@@ -0,0 +1,29 @@		@@ -0,0 +1,29 @@
	1	+class Kalibro::BaseTool < Kalibro::Model
	2	+
	3	+ attr_accessor :name, :description, :supported_metric
	4	+
	5	+ def self.all_names
	6	+ request("BaseTool", :get_base_tool_names)[:base_tool_name].to_a
	7	+ end
	8	+
	9	+ def self.find_by_name(name)
	10	+ new request("BaseTool", :get_base_tool, {:base_tool_name => name})[:base_tool]
	11	+ end
	12	+
	13	+ def supported_metric=(value)
	14	+ @supported_metric = to_objects_array(value, Kalibro::NativeMetric)
	15	+ end
	16	+
	17	+ def supported_metrics
	18	+ @supported_metric
	19	+ end
	20	+
	21	+ def supported_metrics=(supported_metrics)
	22	+ @supported_metric = supported_metrics
	23	+ end
	24	+
	25	+ def metric(name)
	26	+ supported_metrics.find {\|metric\| metric.name == name}
	27	+ end
	28	+
	29	+end
	@@ -1,28 +0,0 @@	@@ -1,28 +0,0 @@
1	-class Kalibro::Client::BaseToolClient
2	-
3	- def self.base_tools
4	- new.base_tool_names
5	- end
6	-
7	- def self.metrics(base_tool)
8	- new.base_tool(base_tool).supported_metrics
9	- end
10	-
11	- def self.metric(metric_name, base_tool)
12	- metrics(base_tool).find {\|metric\| metric.name == metric_name}
13	- end
14	-
15	- def initialize
16	- @port = Kalibro::Client::Port.new('BaseTool')
17	- end
18	-
19	- def base_tool_names
20	- @port.request(:get_base_tool_names)[:base_tool_name].to_a
21	- end
22	-
23	- def base_tool(name)
24	- hash = @port.request(:get_base_tool, {:base_tool_name => name})[:base_tool]
25	- Kalibro::Entities::BaseTool.from_hash(hash)
26	- end
27	-
28	-end
	@@ -1,65 +0,0 @@	@@ -1,65 +0,0 @@
1	-class Kalibro::Client::ProjectClient
2	-
3	- def self.project(project_name)
4	- new.project(project_name)
5	- end
6	-
7	- def self.save(project_content)
8	- project = create_project(project_content)
9	- new.save(project)
10	- end
11	-
12	- def self.remove(project_name)
13	- instance = new
14	- if (instance.project_names.include?(project_name))
15	- instance.remove(project_name)
16	- end
17	- end
18	-
19	- def self.create_project (project_content)
20	- project = Kalibro::Entities::Project.new
21	- project.name = project_content.name
22	- project.license = project_content.license
23	- project.description = project_content.description
24	- project.repository = create_repository(project_content)
25	- project.configuration_name = project_content.configuration_name
26	- project
27	- end
28	-
29	- def self.create_repository(project_content)
30	- repository = Kalibro::Entities::Repository.new
31	- repository.type = project_content.repository_type
32	- repository.address = project_content.repository_url
33	- repository
34	- end
35	-
36	- def initialize
37	- @port = Kalibro::Client::Port.new('Project')
38	- end
39	-
40	- def save(project)
41	- @port.request(:save_project, {:project => project.to_hash})
42	- end
43	-
44	- def project_names
45	- @port.request(:get_project_names)[:project_name].to_a
46	- end
47	-
48	- def project(project_name)
49	- begin
50	- hash = @port.request(:get_project, {:project_name => project_name})[:project]
51	- rescue Exception => error
52	- unless (error.message =~ /There is no project named/).nil?
53	- return nil
54	- else
55	- raise error
56	- end
57	- end
58	- Kalibro::Entities::Project.from_hash(hash)
59	- end
60	-
61	- def remove(project_name)
62	- @port.request(:remove_project, {:project_name => project_name})
63	- end
64	-
65	-end
	@@ -1,17 +0,0 @@		@@ -1,17 +0,0 @@
1	-class Kalibro::Entities::BaseTool < Kalibro::Entities::Entity
2	-
3	- attr_accessor :name, :description, :supported_metric
4	-
5	- def supported_metric=(value)
6	- @supported_metric = to_entity_array(value, Kalibro::Entities::NativeMetric)
7	- end
8	-
9	- def supported_metrics
10	- @supported_metric
11	- end
12	-
13	- def supported_metrics=(supported_metrics)
14	- @supported_metric = supported_metrics
15	- end
16	-
17	-end
18	\ No newline at end of file	0	\ No newline at end of file
	@@ -1,5 +0,0 @@	@@ -1,5 +0,0 @@
1	-class Kalibro::Entities::Metric < Kalibro::Entities::Entity
2	-
3	- attr_accessor :name, :scope, :description
4	-
5	-end
	@@ -1,17 +0,0 @@	@@ -1,17 +0,0 @@
1	-class Kalibro::Entities::NativeMetric < Kalibro::Entities::Metric
2	-
3	- attr_accessor :origin, :language
4	-
5	- def languages
6	- @language
7	- end
8	-
9	- def languages=(languages)
10	- @language = languages
11	- end
12	-
13	- def language=(value)
14	- @language = to_entity_array(value)
15	- end
16	-
17	-end
	@@ -1,12 +0,0 @@	@@ -1,12 +0,0 @@
1	-class Kalibro::Entities::Project < Kalibro::Entities::Entity
2	-
3	- attr_accessor :name, :license, :description, :repository, :configuration_name, :state, :error
4	-
5	- def repository=(value)
6	- @repository = to_entity(value, Kalibro::Entities::Repository)
7	- end
8	-
9	- def error=(value)
10	- @error = to_entity(value, Kalibro::Entities::Error)
11	- end
12	-end
	@@ -1,5 +0,0 @@		@@ -1,5 +0,0 @@
1	-class Kalibro::Entities::Repository < Kalibro::Entities::Entity
2	-
3	- attr_accessor :type, :address, :username, :password
4	-
5	-end
6	\ No newline at end of file	0	\ No newline at end of file
@@ -0,0 +1,5 @@		@@ -0,0 +1,5 @@
	1	+class Kalibro::Metric < Kalibro::Model
	2	+
	3	+ attr_accessor :name, :scope, :description
	4	+
	5	+end