kalibro_client 0.0.1

data/spec/entities/processor/base_spec.rb

@@ -0,0 +1,26 @@
+# This file is part of KalibroClient
+# Copyright (C) 2013  it's respectives authors (please see the AUTHORS file)
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'spec_helper'
+
+describe KalibroClient::Entities::Processor::Base do
+
+  describe 'client' do
+    it 'returns a Faraday::Connection' do
+      expect(KalibroClient::Entities::Processor::Base.client).to be_a(Faraday::Connection)
+    end
+  end
+end

data/spec/entities/processor/metric_collector_details_spec.rb

@@ -0,0 +1,146 @@
+# This file is part of KalibroClient
+# Copyright (C) 2013  it's respectives authors (please see the AUTHORS file)
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'spec_helper'
+
+describe KalibroClient::Entities::Processor::MetricCollectorDetails do
+  describe 'all_names' do
+    context 'with no metric collector details' do
+      before :each do
+        KalibroClient::Entities::Processor::MetricCollectorDetails.
+          expects(:request).
+          with(:names, {}, :get).
+          returns({'names' => nil}.to_json)
+      end
+
+      it 'should return empty array' do
+        expect(KalibroClient::Entities::Processor::MetricCollectorDetails.all_names).to be_empty
+      end
+    end
+
+    context 'with many metric collector details' do
+      let(:metric_collector_details_hash) { FactoryGirl.build(:metric_collector_details).to_hash }
+      let(:another_metric_collector_details_hash) { FactoryGirl.build(:another_metric_collector_details).to_hash }
+
+      before :each do
+        KalibroClient::Entities::Processor::MetricCollectorDetails.
+          expects(:request).
+          with(:names, {}, :get).
+          returns({'metric_collector_names' => [metric_collector_details_hash[:name], another_metric_collector_details_hash[:name]]})
+      end
+
+      it 'should return the two elements' do
+        names = KalibroClient::Entities::Processor::MetricCollectorDetails.all_names
+
+        expect(names.size).to eq(2)
+        expect(names.first).to eq(metric_collector_details_hash[:name])
+        expect(names.last).to eq(another_metric_collector_details_hash[:name])
+      end
+    end
+  end
+
+  describe 'all' do
+    context 'with no metric collector details' do
+      before :each do
+        KalibroClient::Entities::Processor::MetricCollectorDetails.
+          expects(:request).
+          with('', {}, :get).
+          returns({"metric_collector_details" => nil})
+      end
+
+      it 'should return empty array' do
+        expect(KalibroClient::Entities::Processor::MetricCollectorDetails.all).to be_empty
+      end
+    end
+
+    context 'with many metric collector details' do
+      let!(:metric_collector_details_hash) { FactoryGirl.attributes_for(:metric_collector_details) }
+      let!(:another_metric_collector_details_hash) { FactoryGirl.attributes_for(:another_metric_collector_details) }
+
+      before :each do
+        KalibroClient::Entities::Processor::MetricCollectorDetails.
+          expects(:request).
+          with('', {}, :get).
+          returns({"metric_collector_details" => [metric_collector_details_hash, another_metric_collector_details_hash]})
+      end
+
+      it 'should return the two elements' do
+        metric_collector_details = KalibroClient::Entities::Processor::MetricCollectorDetails.all
+
+        expect(metric_collector_details.size).to eq(2)
+        expect(metric_collector_details.first.name).to eq(metric_collector_details_hash[:name])
+        expect(metric_collector_details.last.name).to eq(another_metric_collector_details_hash[:name])
+      end
+    end
+  end
+
+  describe 'find_by_name' do
+    subject { FactoryGirl.build(:metric_collector_details) }
+
+    context 'with an inexistent name' do
+      before :each do
+        KalibroClient::Entities::Processor::MetricCollectorDetails.
+          expects(:request).
+          with(:find, {name: subject.name}).
+          returns(nil)
+      end
+
+      it 'should raise a RecordNotFound error' do
+        expect { KalibroClient::Entities::Processor::MetricCollectorDetails.find_by_name(subject.name)}.
+          to raise_error(KalibroClient::Errors::RecordNotFound)
+      end
+    end
+
+    context 'with an existent name' do
+      before :each do
+        KalibroClient::Entities::Processor::MetricCollectorDetails.
+          expects(:request).
+          with(:find,{name: subject.name}).
+          returns({"metric_collector_details" => subject.to_hash({except: ["supported_metrics"]})})
+      end
+
+      it 'should return a metric_collector_details' do
+        expect(KalibroClient::Entities::Processor::MetricCollectorDetails.find_by_name(subject.name).name).to eq(subject.name)
+      end
+    end
+  end
+
+  describe 'Supported Metrics' do
+    let(:code_and_metric) { { "total_abstract_classes" => FactoryGirl.build(:metric) } }
+    #FIXME: Mocha is creating the expectations with strings, but FactoryGirl returns everything with sybols and integers
+    let(:code_and_metric_parameter) { { "total_abstract_classes" => Hash[FactoryGirl.attributes_for(:metric)] } }
+
+    context 'supported_metrics acessors' do
+      it 'should set the value of the array of supported metrics' do
+        subject.supported_metrics = code_and_metric_parameter
+        expect(subject.supported_metrics["total_abstract_classes"].to_hash).to eql(code_and_metric["total_abstract_classes"].to_hash)
+      end
+    end
+  end
+
+  describe 'metric' do
+    subject { FactoryGirl.build(:metric_collector_details) }
+    let(:metric) { subject.supported_metrics["loc"] }
+
+    it 'should return nil with an inexistent name' do
+      expect(subject.metric("fake name")).to be_nil
+    end
+
+    it 'should return a metric with an existent name' do
+      expect(subject.metric(metric.name).name).to eq(metric.name)
+    end
+  end
+end

data/spec/entities/processor/metric_result_spec.rb

@@ -0,0 +1,209 @@
+# This file is part of KalibroClient
+# Copyright (C) 2013  it's respectives authors (please see the AUTHORS file)
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'spec_helper'
+
+describe KalibroClient::Entities::Processor::MetricResult do
+  let(:metric_configuration) { FactoryGirl.build(:metric_configuration_with_id) }
+  subject { FactoryGirl.build(:metric_result, metric_configuration_id: metric_configuration.id) }
+
+  describe 'new' do
+    context 'with value NaN' do
+      it 'should set the value with aggregated_value' do
+        attributes_hash = FactoryGirl.build(:metric_result, {"aggregated_value" => 1.6}).to_hash
+        attributes_hash["value"] = "NaN"
+        metric_result = KalibroClient::Entities::Processor::MetricResult.new(attributes_hash)
+        expect(metric_result.value).to eq(1.6)
+      end
+    end
+  end
+
+  describe 'id=' do
+    it 'should set the value of the attribute id' do
+      subject.id = 42
+      expect(subject.id).to eq(42)
+    end
+  end
+
+  describe 'metric_configuration=' do
+    it 'should set the metric configuration' do
+      subject.metric_configuration = metric_configuration
+      expect(subject.metric_configuration.weight).to eq(metric_configuration.weight)
+      expect(subject.metric_configuration.aggregation_form).to eq(metric_configuration.aggregation_form)
+      expect(subject.metric_configuration.reading_group_id).to eq(metric_configuration.reading_group_id)
+      expect(subject.metric_configuration.kalibro_configuration_id).to eq(metric_configuration.kalibro_configuration_id)
+      expect(subject.metric_configuration_id).to eq(metric_configuration.id)
+    end
+  end
+
+  describe 'metric_configuration' do
+
+    context 'without a set metric configuration' do
+      it 'should fetch and return the metric configuration' do
+        KalibroClient::Entities::Configurations::MetricConfiguration.expects(:find).with(metric_configuration.id).returns(metric_configuration)
+        expect(subject.metric_configuration).to eq(metric_configuration)
+      end
+    end
+
+    context 'with a set metric configuration' do
+      before :each do
+        subject.metric_configuration = metric_configuration
+      end
+
+      it 'should only return the metric configuration' do
+        expect(subject.metric_configuration).to eq(metric_configuration)
+      end
+
+      it 'should set the metric configuration id' do
+        expect(subject.metric_configuration_id).to eq(metric_configuration.id)
+      end
+    end
+  end
+
+  describe 'value=' do
+    it 'should set the value of the attribute value' do
+      subject.value = 42
+      expect(subject.value).to eq(42)
+    end
+  end
+
+  describe 'aggregated_value=' do
+    it 'should set the value of the attribute aggregated_value' do
+      subject.aggregated_value = 42
+      expect(subject.aggregated_value).to eq(42)
+    end
+  end
+
+  describe 'descendant_values' do
+    context 'when there is one descendant value for the given metric_result' do
+      before :each do
+        KalibroClient::Entities::Processor::MetricResult.
+          expects(:request).
+          with(':id/descendant_values', { id: subject.id }, :get).
+          returns({'descendant_values' => [13.3]})
+      end
+
+      it 'should return an unitary list with the descendant value' do
+        expect(subject.descendant_values).to eq([13.3])
+      end
+    end
+
+    context 'when there is no descendant value for the given metric_result' do
+      before :each do
+        KalibroClient::Entities::Processor::MetricResult.
+          expects(:request).
+          with(':id/descendant_values', { id: subject.id }, :get).
+          returns({'descendant_values' => []})
+      end
+
+      it 'should return an empty list' do
+        expect(subject.descendant_values).to eq([])
+      end
+    end
+  end
+
+  describe 'metric_results_of' do
+    context 'when there is one metric result for the given module_result' do
+      before :each do
+        KalibroClient::Entities::Processor::ModuleResult.
+          expects(:request).
+          with(':id/metric_results', { id: 123 }, :get).
+          returns({'metric_results' => [subject.to_hash]})
+      end
+
+      it 'should return an unitary list with the metric result' do
+        expect(KalibroClient::Entities::Processor::MetricResult.metric_results_of(123).first.value).to eq(subject.value)
+      end
+    end
+
+    context 'when there is no metric result for the given module_result' do
+      before :each do
+        KalibroClient::Entities::Processor::ModuleResult.
+          expects(:request).
+          with(':id/metric_results', { :id => 42 }, :get).
+          returns({'metric_results' => []})
+      end
+
+      it 'should return an empty list' do
+        expect(KalibroClient::Entities::Processor::MetricResult.metric_results_of(42)).to eq([])
+      end
+    end
+
+    context 'when there are many metric results for the given module_result' do
+      before :each do
+        KalibroClient::Entities::Processor::ModuleResult.
+          expects(:request).
+          with(':id/metric_results', { :id => 28 }, :get).
+          returns({'metric_results' => [subject.to_hash, subject.to_hash]})
+      end
+
+      it 'should return a list with the descendant results' do
+        expect(KalibroClient::Entities::Processor::MetricResult.metric_results_of(28).first.value).to eq(subject.value)
+      end
+    end
+  end
+
+  describe 'history_of' do
+    let(:kalibro_module) { FactoryGirl.build(:kalibro_module_with_id) }
+    let(:metric) { FactoryGirl.build(:metric) }
+    let(:repository) { FactoryGirl.build(:repository_with_id) }
+
+    context 'when there is not a date metric result' do
+      before :each do
+        KalibroClient::Entities::Processor::Repository.
+          expects(:request).
+          with(':id/metric_result_history_of', {:metric_name => metric.name, :kalibro_module_id => kalibro_module.id, id: repository.id}).
+          returns({'metric_result_history_of' => []})
+      end
+
+      it 'should return an empty list' do
+        expect(KalibroClient::Entities::Processor::MetricResult.history_of(metric.name, kalibro_module.id, repository.id)).to eq([])
+      end
+    end
+
+    context 'when there is only one date metric result' do
+      let!(:date_metric_result) { FactoryGirl.build(:date_metric_result, metric_result: subject.to_hash) }
+
+      before :each do
+        KalibroClient::Entities::Processor::Repository.
+          expects(:request).with(':id/metric_result_history_of', {:metric_name => metric.name, :kalibro_module_id => kalibro_module.id, id: repository.id})
+          .returns({'metric_result_history_of' => [date_metric_result.to_hash]})
+      end
+
+      it 'should return the date metric result as an object into a list' do
+        expect(KalibroClient::Entities::Processor::MetricResult.history_of(metric.name, kalibro_module.id, repository.id).first.metric_result.id).to eq(subject.id)
+      end
+    end
+
+    context 'when there are many date metric results' do
+      let(:date_metric_result) { FactoryGirl.build(:date_metric_result, {metric_result: subject.to_hash}) }
+      let(:another_date_metric_result) { FactoryGirl.build(:another_date_metric_result, {metric_result: subject.to_hash}) }
+
+      before :each do
+        KalibroClient::Entities::Processor::Repository.
+          expects(:request).
+          with(':id/metric_result_history_of', {:metric_name => metric.name, :kalibro_module_id => kalibro_module.id, id: repository.id}).
+          returns({'metric_result_history_of' => [date_metric_result.to_hash, another_date_metric_result.to_hash]})
+      end
+
+      it 'should return a list of date metric results as objects' do
+        response = KalibroClient::Entities::Processor::MetricResult.history_of(metric.name, kalibro_module.id, repository.id)
+        expect(response.first.metric_result.id).to eq(date_metric_result.metric_result.id)
+        expect(response.last.metric_result.id).to eq(another_date_metric_result.metric_result.id)
+      end
+    end
+  end
+end

data/spec/entities/processor/module_result_spec.rb

@@ -0,0 +1,178 @@
+# This file is part of KalibroClient
+# Copyright (C) 2013  it's respectives authors (please see the AUTHORS file)
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'spec_helper'
+
+describe KalibroClient::Entities::Processor::ModuleResult do
+  subject { FactoryGirl.build(:module_result, id: rand(Time.now.to_i)) }
+
+  describe 'find' do
+    context 'when there is a module result for the given id' do
+      before :each do
+        KalibroClient::Entities::Processor::ModuleResult.
+          expects(:request).
+          with(':id/exists', { id: subject.id }, :get).
+          returns("exists" => true)
+        KalibroClient::Entities::Processor::ModuleResult.
+          expects(:request).
+          with(':id', { id: subject.id }, :get).
+          returns("module_result" => subject.to_hash)
+      end
+
+      it 'should return a hash with module result' do
+        expect(KalibroClient::Entities::Processor::ModuleResult.
+          find(subject.id).id).to eq(subject.id)
+      end
+    end
+
+    context "when there isn't a module result for the given id" do
+      before :each do
+        KalibroClient::Entities::Processor::ModuleResult.
+          expects(:request).
+          with(':id/exists', { id: subject.id }, :get).
+          returns("exists" => false)
+      end
+
+      it 'should raise an error' do
+        expect {KalibroClient::Entities::Processor::ModuleResult.find(subject.id)}.
+          to raise_error KalibroClient::Errors::RecordNotFound
+      end
+    end
+  end
+
+  describe 'children' do
+    before :each do
+      KalibroClient::Entities::Processor::ModuleResult.
+        expects(:request).
+        with(':id/children', {id: subject.id}, :get).
+        returns({'module_results' => subject.to_hash})
+    end
+
+    it 'should return a list of objects' do
+      expect(subject.children).to eq [subject]
+    end
+  end
+
+  describe 'parents' do
+    let(:root_module_result) { FactoryGirl.build(:root_module_result) }
+
+    context 'when module result has a parent' do
+      before :each do
+        KalibroClient::Entities::Processor::ModuleResult.
+          expects(:request).
+          with(':id/exists', { id: subject.parent_id }, :get).
+          returns("exists" => true)
+        KalibroClient::Entities::Processor::ModuleResult.
+          expects(:request).at_least_once.
+          with(':id', { id: subject.parent_id }, :get).
+          returns("module_result" => root_module_result.to_hash)
+      end
+
+      it 'should return its parent' do
+        expect(subject.parents).to eq [root_module_result]
+      end
+    end
+
+    context 'when module result does not have a parent' do
+      it 'should return an empty list' do
+        expect(root_module_result.parents).to eq []
+      end
+    end
+  end
+
+  describe 'id=' do
+    it 'should set the id attribute as integer' do
+      subject.id = 23
+      expect(subject.id).to eq 23
+    end
+  end
+
+  describe 'kalibro_module' do
+    let(:kalibro_module) { FactoryGirl.build(:kalibro_module) }
+
+    before :each do
+      KalibroClient::Entities::Processor::ModuleResult.
+          expects(:request).once.
+          with(':id/kalibro_module', { id: subject.id }, :get).
+          returns("kalibro_module" => kalibro_module.to_hash)
+    end
+
+    it 'should return the kalibro_module' do
+      expect(subject.kalibro_module).to eq(kalibro_module)
+    end
+
+    it 'should not request the kalibro_module in cache' do
+      expect(subject.kalibro_module).to eq(kalibro_module)
+    end
+  end
+
+  describe 'grade=' do
+    it 'should set the grade attribute as float' do
+      subject.grade = 12.5
+      expect(subject.grade).to eq 12.5
+    end
+  end
+
+  describe 'parent_id=' do
+    it 'should set the parent_id attribute as integer' do
+      subject.parent_id = 73
+      expect(subject.parent_id).to eq 73
+    end
+  end
+
+  describe 'history_of' do
+    let(:date_module_result) { FactoryGirl.build(:date_module_result) }
+    before :each do
+      KalibroClient::Entities::Processor::ModuleResult.
+        expects(:request).
+        with('history_of', {id: subject.id}).
+        returns({'date_module_results' => [[date_module_result.date, date_module_result.module_result.to_hash]]})
+    end
+
+    it 'should return a list of date_module_results' do
+      date_module_results = KalibroClient::Entities::Processor::ModuleResult.history_of subject.id
+      expect(date_module_results.first.result).to eq date_module_result.result
+    end
+  end
+
+  describe 'folder? & file?' do
+    context 'when the module result has childrens' do
+      subject { FactoryGirl.build(:root_module_result) }
+
+      before :each do
+        subject.expects(:children).twice.returns([FactoryGirl.build(:module_result)])
+      end
+
+      it 'should return true for folder? and false for file?' do
+        expect(subject.folder?).to be_truthy
+        expect(subject.file?).to be_falsey
+      end
+    end
+
+    context 'when the module result has no childrens' do
+      subject { FactoryGirl.build(:module_result) }
+
+      before :each do
+        subject.expects(:children).twice.returns([])
+      end
+
+      it 'should return true for folder? and false for file?' do
+        expect(subject.folder?).to be_falsey
+        expect(subject.file?).to be_truthy
+      end
+    end
+  end
+end