kalibro_client 2.1.2 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e191f0d8e9425cbd141f40fa5394d0304111a341
-  data.tar.gz: 332b0704428ff197560f47326e24d4f501b49509
+  metadata.gz: 40b036706870cceebb217fb718eb8816f1cda7e6
+  data.tar.gz: 1f6b0ced25ec1c38a6c1269ce340958ead0f4760
 SHA512:
-  metadata.gz: 218d5627657e6aea3dcf3d164b49b7f412cee62cec5486bb8ac7e145b1387d0e6860ed1b325d87d39d537e2e4fb3e55d965d3083694d9b4d24a133895187ecf8
-  data.tar.gz: 61551fff5abe5367175a4d9d4f045b3de3edc20739c13c1d4dbcf8fee65661276aeb02f6fc8a24b9e5b9c93a6489011969fd0dfc646aada426a5cbc4a875b85c
+  metadata.gz: 942f57893671ef4a267c52550005bd355c9d69e6ec86d7f3f62edaf606a24efb94741bb54944238dcb57ddab6f0ed85b05f4046a54eead1e44bcdab5ff19e963
+  data.tar.gz: 80559612be69e952c80dc779404d1bdc02274f4c05aecb1dc39f34704e10602b8b02f084db4669ea84a9b49a54d5d841cfb028fcb8161c27bab472fb0ef923d2

data/.ruby-version

@@ -1 +1 @@
-ruby-2.2.3
+ruby-2.3.0

data/.travis.yml

@@ -1,15 +1,21 @@
 language: ruby
 rvm:
-  - 2.2.3
+  - 2.3.0
+  - 2.0.0-p598 # CentOS 7
+  - 2.1.5 # Debian 8
 
 addons:
   postgresql: "9.3"
 
+before_install:
+  - if ruby --version | cut -d ' ' -f 2 | grep -q 2.1.5p273 ; then gem update --system 2.4.8; fi
+  - gem --version
+
 before_script:
   # Remove bugged libzmq3 package, see https://github.com/travis-ci/travis-ci/issues/982 and https://github.com/travis-ci/travis-ci/issues/1715 for details
   - sudo apt-get remove libzmq3
   - git clone https://github.com/mezuro/kalibro_install.git -b v4.0 kalibro_install
-  - KALIBRO_PROCESSOR_VERSION='v1.1.2' KALIBRO_CONFIGURATIONS_VERSION='v1.2.0' ./kalibro_install/install.sh
+  - KALIBRO_PROCESSOR_VERSION='v1.1.6' KALIBRO_CONFIGURATIONS_VERSION='v2.0.0' ./kalibro_install/install.sh
   - cp features/support/kalibro_cucumber_helpers.yml.sample features/support/kalibro_cucumber_helpers.yml
   - export BUNDLE_GEMFILE=$PWD/Gemfile
   - export CODECLIMATE_REPO_TOKEN=46cbb96b053b03ad66b0355bd96d0787f56fc5a4fc171b8d6eb30c421c5e6777

data/AUTHORS

@@ -1,5 +1,6 @@
 Daniel Quadros Miranda
 Diego Araújo Martinez
+Eduardo Silva Araújo
 Heitor Reis Ribeiro
 Rafael Reggiani Manzo
 

data/README.md

@@ -4,7 +4,14 @@
 [![Code Climate](https://codeclimate.com/github/mezuro/kalibro_client.png)](https://codeclimate.com/github/mezuro/kalibro_client)
 [![Test Coverage](https://codeclimate.com/github/mezuro/kalibro_client/badges/coverage.svg)](https://codeclimate.com/github/mezuro/kalibro_client)
 
-KalibroClient is a Ruby gem intended to be an interface for Ruby applications who want to use the open source code analysis webservice Kalibro (http://gitorious.org/kalibro/kalibro).
+KalibroClient is a Ruby gem intended to be an interface for Ruby applications who want to use the open source code analysis webservices from Kalibro (https://github.com/mezuro/kalibro_processor and https://github.com/mezuro/kalibro_configurations).
+
+## Contributing
+
+Please, have a look the wiki pages about development workflow and code standards:
+
+* https://github.com/mezuro/mezuro/wiki/Development-workflow
+* https://github.com/mezuro/mezuro/wiki/Standards
 
 ## Installation
 
@@ -24,7 +31,7 @@ Or install it yourself as:
 
 KalibroClient is intended to be an easy interface that encapsulates the usage of all the Kalibro service's endpoints. So have a look at the available entities at `lib/kalibro_client/entities`.
 
-All the entities are subclasses from `Model`, so have a good look at it. Specially notice that all the entities have methods:
+All the entities are subclasses from `KalibroClient::Entities::Base`, so have a good look at it. Specially notice that all the entities have methods:
 
 * `save`
 * `exists?`
@@ -35,7 +42,7 @@ These four methods should be useful.
 
 We hope to make available soon a full documentation on RDoc that will make easier to understand all this.
 
-A good example on how to get everything from KalibroClient should be Mezuro. So, have a look there for some examples.
+A good example on how to get everything from KalibroClient should be Prezento (https://github.com/mezuro/prezento). So, have a look there for some examples.
 
 ### Cucumber helpers
 
@@ -47,31 +54,15 @@ Just add to your `env.rb` the following:
 
 The test configurations available are:
 
-* database
-* user
-* password
-* psql_file_path
-* query_file_path
-* kalibro_home
-* tomcat_user
-* tomcat_group
-* tomcat_restart_command
+* `kalibro_processor_address`
+* `kalibro_configurations_address`
 
 An example on how to change them is:
 
-    KalibroClient::KalibroCucumberHelpers.configure do |config|
-      config.database = "kalibro_test"
-    end
+```ruby
+KalibroClient::KalibroCucumberHelpers.configure do |config|
+  config.kalibro_processor_address = "http://localhost:8082"
+end
+```
 
 We hope to make available soon an YAML parser for test configurations.
-
-## Contributing
-
-0. Install RVM (rvm.io)
-1. Fork it
-2. Run `bundle install`
-3. Create your feature branch (`git checkout -b my-new-feature`)
-4. Make your modifications and changes
-5. Commit your changes (`git commit -am 'Add some feature'`)
-6. Push to the branch (`git push origin my-new-feature`)
-7. Create new Pull Request

data/features/metric_result/module_results.feature

@@ -18,3 +18,4 @@ Feature: Module Results
     When I get the first metric result of the given processing
     And I ask for the module result of the given metric result
     Then I should get the metric result's module result
+    And the module result should have a granularity

data/features/module_result/kalibro_module.feature

@@ -0,0 +1,18 @@
+Feature: kalibro_module
+  In order to be able to retrieve the ModuleResult's KalibroModule
+  As a developer
+  I want to make the proper requests
+
+  @kalibro_configuration_restart @kalibro_processor_restart
+  Scenario: find a valid module result
+    Given I have a project with name "Kalibro"
+    And I have a kalibro configuration with name "Conf"
+    And I have a reading group with name "Group"
+    And I have a "saikuro" configuration within the given kalibro configuration
+    And the given project has the following Repositories:
+      |   name    | scm_type |                   address                        |
+      |  Kalibro  |    GIT   | https://github.com/mezuro/kalibro_processor.git  |
+    And I call the process method for the given repository
+    And I wait up for a ready processing
+    When I ask for the kalibro_module of the processing root module result
+    Then I should get a KalibroModule

data/features/repository/processing/last_processing_state.feature

@@ -15,4 +15,4 @@ Feature: Last processing state
     And I call the process method for the given repository
     And I wait up to 1 seconds
     When I call the last_processing_state method for the given repository
-    Then I should get "PREPARING"
+    Then I should get a valid state

data/features/repository/processing/processing.feature

@@ -15,7 +15,7 @@ Feature: Processing
     And I call the process method for the given repository
     And I wait up to 1 seconds
     When I call the processing method for the given repository
-    Then I should get a Processing with state "PREPARING"
+    Then I should get a Processing
 
   @kalibro_processor_restart @kalibro_configuration_restart
   Scenario: With one repository just after with ready processing

data/features/step_definitions/metric_result_steps.rb

@@ -44,3 +44,8 @@ end
 Then(/^I should get the metric result's module result$/) do
   expect(@module_result.id).to eq(@metric_result.module_result_id)
 end
+
+Then(/^the module result should have a granularity$/) do
+  expect(@module_result.kalibro_module.granularity).to be_a(KalibroClient::Entities::Miscellaneous::Granularity)
+end
+

data/features/step_definitions/module_result_steps.rb

@@ -44,3 +44,11 @@ end
 Then(/^The first children should have a module$/) do
   expect(@children.first.kalibro_module).to be_a(KalibroClient::Entities::Processor::KalibroModule)
 end
+
+When(/^I ask for the kalibro_module of the processing root module result$/) do
+  @kalibro_module = KalibroClient::Entities::Processor::ModuleResult.find(@repository.processing.root_module_result_id).kalibro_module
+end
+
+Then(/^I should get a KalibroModule$/) do
+  expect(@kalibro_module).to be_a(KalibroClient::Entities::Processor::KalibroModule)
+end

data/features/step_definitions/processing_steps.rb

@@ -76,6 +76,13 @@ Then(/^I should get "(.*?)"$/) do |state|
   expect(@response).to eq(state)
 end
 
+Then(/^I should get a valid state$/) do
+  # REFACTOR ME: maybe the list of valid states should be retrieved from the Processor
+  states = ["PREPARING", "DOWNLOADING", "COLLECTING",
+            "CHECKING", "BUILDING", "AGGREGATING", "CALCULATING", "INTERPRETING"]
+  expect(states).to include(@response)
+end
+
 Then(/^I should get false$/) do
   expect(@response).to be_falsey
 end

data/kalibro_client.gemspec

@@ -37,8 +37,8 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", "~> 3.3.0"
-  spec.add_development_dependency "cucumber", "~> 2.0.2"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "cucumber", "~> 2.0"
   spec.add_development_dependency "mocha", "~> 1.1.0"
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "factory_girl", "~> 4.5.0"

data/lib/kalibro_client/entities/miscellaneous/granularity.rb

@@ -1,7 +1,7 @@
 module KalibroClient
   module Entities
     module Miscellaneous
-      class Granularity
+      class Granularity < KalibroClient::Entities::Miscellaneous::Base
         include Comparable
 
         GRANULARITIES = [:METHOD, :CLASS, :PACKAGE, :SOFTWARE, :FUNCTION]
@@ -21,6 +21,7 @@ module KalibroClient
         attr_reader :type
 
         def initialize(type)
+          type = type.to_sym
           if GRANULARITIES.include?(type)
             @type = type
           else

data/lib/kalibro_client/entities/miscellaneous/metric.rb

@@ -10,9 +10,18 @@ module KalibroClient
           @type = type
           @name = name
           @code = code
-          @scope = scope
+          self.scope = scope
           @description = ""
         end
+
+        def scope=(value)
+          if value.is_a?(Hash) && !value["type"].nil?
+            value = value["type"]
+          else
+            value = value.to_s
+          end
+          @scope = KalibroClient::Entities::Miscellaneous::Granularity.new(value)
+        end
       end
     end
   end

data/lib/kalibro_client/entities/processor/kalibro_module.rb

@@ -20,6 +20,11 @@ module KalibroClient
       class KalibroModule < KalibroClient::Entities::Processor::Base
         attr_accessor :granularity, :id, :long_name, :module_result_id
 
+        def initialize(attributes = {}, persisted = false)
+          super
+          @granularity = KalibroClient::Entities::Miscellaneous::Granularity.new attributes['granularity']['type']
+        end
+
         def name=(value)
           @long_name = (value.is_a?(Array) ? value.join('.') : value)
         end

data/lib/kalibro_client/helpers/hash_converters.rb

@@ -5,7 +5,7 @@
 # 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

data/lib/kalibro_client/version.rb

@@ -15,5 +15,5 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 module KalibroClient
-  VERSION = "2.1.2"
+  VERSION = "3.0.0"
 end

data/spec/entities/miscellaneous/compound_metric_spec.rb

@@ -21,7 +21,7 @@ describe KalibroClient::Entities::Miscellaneous::CompoundMetric, :type => :model
 
       context 'with a hash' do
         it 'is expected to create a object from the hash' do
-          subject_hash = Hash[subject.to_hash.map { |k,v| if v.is_a?(Array) then [k.to_s, v] else [k.to_s, v.to_s] end}]
+          subject_hash = subject.to_hash
           expect(KalibroClient::Entities::Miscellaneous::CompoundMetric.to_object(subject_hash)).to eq(subject)
         end
       end

data/spec/entities/miscellaneous/metric_spec.rb

@@ -11,5 +11,22 @@ describe KalibroClient::Entities::Miscellaneous::Metric, :type => :model do
         expect(KalibroClient::Entities::Miscellaneous::Metric.new(compound, name, code, scope)).to be_a(KalibroClient::Entities::Miscellaneous::Metric)
       end
     end
+
+    describe 'scope=' do
+      subject { FactoryGirl.build(:metric) }
+      context 'with a valid granularity' do
+        it 'is expected to instantiate a Granularity' do
+          subject.scope = {"type" => "CLASS"}
+          expect(subject.scope).to be_a KalibroClient::Entities::Miscellaneous::Granularity
+        end
+      end
+
+      context 'with an invalid granularity' do
+        it 'is expected to raise a TypeError' do
+          scope = nil
+          expect { subject.scope = scope }.to raise_error TypeError
+        end
+      end
+    end
   end
 end

data/spec/entities/miscellaneous/native_metric_spec.rb

@@ -22,7 +22,7 @@ describe KalibroClient::Entities::Miscellaneous::NativeMetric, :type => :model d
 
       context 'with a hash' do
         it 'is expected to create a object from the hash' do
-          subject_hash = Hash[subject.to_hash.map { |k,v| if v.is_a?(Array) then [k.to_s, v] else [k.to_s, v.to_s] end}]
+          subject_hash = subject.to_hash
           expect(KalibroClient::Entities::Miscellaneous::NativeMetric.to_object(subject_hash)).to eq(subject)
         end
       end

data/spec/entities/processor/hotspot_metric_result_spec.rb

@@ -20,7 +20,7 @@ describe KalibroClient::Entities::Processor::HotspotMetricResult do
   describe 'new' do
     context 'with the expected attributes' do
       let(:attributes) { FactoryGirl.build(:hotspot_metric_result).to_hash }
-      subject { KalibroClient::Entities::Processor::HotspotMetricResult.new attributes } 
+      subject { KalibroClient::Entities::Processor::HotspotMetricResult.new attributes }
 
       it 'should cast the line_number attribute to an integer' do
         expect(subject.line_number).to be_a Integer
@@ -46,4 +46,3 @@ describe KalibroClient::Entities::Processor::HotspotMetricResult do
     end
   end
 end
-

data/spec/entities/processor/kalibro_module_spec.rb

@@ -5,7 +5,7 @@
 # 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
@@ -48,4 +48,10 @@ describe KalibroClient::Entities::Processor::KalibroModule do
       expect(subject.short_name).to eq(subject.long_name.split(".").last)
     end
   end
+
+  describe 'granularity' do
+    it 'is expected to be a granularity object' do
+      expect(subject.granularity).to be_a KalibroClient::Entities::Miscellaneous::Granularity
+    end
+  end
 end

data/spec/entities/processor/module_result_spec.rb

@@ -63,18 +63,29 @@ describe KalibroClient::Entities::Processor::ModuleResult do
     let(:kalibro_module) { FactoryGirl.build(:kalibro_module) }
 
     before :each do
+    end
+
+    it 'is expected to request the kalibro_module' do
       KalibroClient::Entities::Processor::ModuleResult.
-          expects(:request).once.
+          expects(:request).
           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)
+    context 'when a previous request has already been made' do
+      before :each do
+        KalibroClient::Entities::Processor::ModuleResult.
+            expects(:request).
+            with(':id/kalibro_module', { id: subject.id }, :get).
+            returns("kalibro_module" => kalibro_module.to_hash)
+
+        subject.kalibro_module
+      end
+
+      it 'should not request the kalibro_module and return the cached one' do
+        expect(subject.kalibro_module).to eq(kalibro_module)
+      end
     end
   end
 

data/spec/factories/kalibro_module.rb

@@ -17,12 +17,14 @@
 FactoryGirl.define do
   factory :kalibro_module, class: KalibroClient::Entities::Processor::KalibroModule do
     name 'Qt-Calculator'
-    granularity 'APPLICATION'
+    granularity { {type: FactoryGirl.build(:granularity).type }.stringify_keys }
 
     trait :with_id do
       id 1
     end
 
     factory :kalibro_module_with_id, traits: [:with_id]
+
+    initialize_with { KalibroClient::Entities::Processor::KalibroModule.new({ name: name, granularity: granularity }.stringify_keys) }
   end
 end

data/spec/factories/metrics.rb

@@ -19,7 +19,7 @@ FactoryGirl.define do
     name "Total Abstract Classes"
     code "total_abstract_classes"
     type "native"
-    scope "SOFTWARE"
+    scope FactoryGirl.build(:granularity)
     description ""
 
     initialize_with { KalibroClient::Entities::Miscellaneous::Metric.new(type, name, code, scope) }
@@ -28,7 +28,7 @@ FactoryGirl.define do
   factory :loc, class: KalibroClient::Entities::Miscellaneous::NativeMetric do
     name "Lines of Code"
     code "loc"
-    scope "CLASS"
+    scope FactoryGirl.build(:granularity, type: "CLASS")
     description ""
     languages nil
     metric_collector_name "Analizo"
@@ -39,7 +39,7 @@ FactoryGirl.define do
   factory :compound_metric, class: KalibroClient::Entities::Miscellaneous::CompoundMetric do
     name "Lines of Code"
     code "loc"
-    scope "CLASS"
+    scope FactoryGirl.build(:granularity, type: "CLASS")
     description ""
     script "return 0;"
 
@@ -59,7 +59,7 @@ FactoryGirl.define do
   factory :saikuro, class: KalibroClient::Entities::Miscellaneous::NativeMetric do
     name 'Cyclomatic Complexity'
     code 'saikuro'
-    scope 'METHOD'
+    scope FactoryGirl.build(:granularity, type: 'METHOD')
     description ''
     metric_collector_name 'MetricFu'
     languages nil

data/spec/helpers/hash_converters_spec.rb

@@ -79,6 +79,15 @@ describe HashConverters do
         expect(convert_to_hash(-1.0/0.0)).to eq('-INF')
       end
     end
+
+    context 'with a granularity' do
+      let(:granularity) { FactoryGirl.build(:granularity) }
+
+      it 'is expected to convert the granularity to a hash' do
+        expect(convert_to_hash(granularity)).to be_a Hash
+        expect(convert_to_hash(granularity)).to include 'type'
+      end
+    end
   end
 
   describe 'field_to_hash' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kalibro_client
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 3.0.0
 platform: ruby
 authors:
 - Daniel Quadros Miranda
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-23 00:00:00.000000000 Z
+date: 2016-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -47,28 +47,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -216,6 +216,7 @@ files:
 - features/module_result/children.feature
 - features/module_result/find.feature
 - features/module_result/history_of.feature
+- features/module_result/kalibro_module.feature
 - features/project/all.feature
 - features/project/creation.feature
 - features/project/destroy.feature
@@ -429,6 +430,7 @@ test_files:
 - features/module_result/children.feature
 - features/module_result/find.feature
 - features/module_result/history_of.feature
+- features/module_result/kalibro_module.feature
 - features/project/all.feature
 - features/project/creation.feature
 - features/project/destroy.feature