kalibro_entities 0.0.1.rc1

data/features/support/env.rb

@@ -0,0 +1,25 @@
+# SimpleCov for test coverage report
+require 'simplecov'
+SimpleCov.start do
+  add_group "Entities", "lib/kalibro_entities/entities"
+  add_group "Errors", "lib/kalibro_entities/errors"
+  add_group "Helpers", "lib/kalibro_entities/helpers"
+  add_group "Cucumber Helpers", "lib/kalibro_entities/kalibro_cucumber_helpers"
+
+  add_filter "/spec/"
+  add_filter "/features/"
+
+  coverage_dir 'coverage/cucumber'
+end
+
+# Kalibro hooks
+require 'kalibro_entities/kalibro_cucumber_helpers/hooks'
+
+# Configuring the right hooks
+KalibroEntities::KalibroCucumberHelpers.configure_from_yml("#{__dir__}/kalibro_cucumber_helpers.yml")
+
+# The gem itself
+require 'kalibro_entities'
+
+require 'factory_girl'
+FactoryGirl.find_definitions

data/features/support/kalibro_cucumber_helpers.yml.sample

@@ -0,0 +1,10 @@
+kalibro_cucumber_helpers:
+  database: "kalibro_test"
+  user: "kalibro"
+  password: "kalibro"
+  psql_file_path: "/tmp/PostgreSQL.sql"
+  query_file_path: "/tmp/query"
+  kalibro_home: "/usr/share/tomcat6/.kalibro"
+  tomcat_user: "tomcat6"
+  tomcat_group: "tomcat6"
+  tomcat_restart_command: "sudo\\ service\\ tomcat6\\ restart"

data/kalibro_entities.gemspec

@@ -0,0 +1,48 @@
+# This file is part of KalibroEntities
+# 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/>.
+
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kalibro_entities/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "kalibro_entities"
+  spec.version       = KalibroEntities::VERSION
+  spec.authors       = ["Carlos Morais", "Daniel Paulino Alves", "Diego Araújo Martinez", "Fellipe Souto", "Guilherme Rojas V. de Lima", "João M. M. da Silva", "Rafael Reggiani Manzo", "Renan Fichberg"]
+  spec.email         = ["carlos88morais@gmail.com", "danpaulalves@gmail.com", "diegamc90@gmail.com", "fllsouto@gmail.com","guilhermehrojas@gmail.com", "jaodsilv@linux.ime.usp.br", "rr.manzo@gmail.com", "rfichberg@gmail.com"]
+  spec.description   = "KalibroEntities 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)."
+  spec.summary       = "KalibroEntites is a communication interface with the Kalibro service."
+  spec.homepage      = "https://github.com/mezuro/kalibro_entities"
+  spec.license       = "LGPLv3"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.14"
+  spec.add_development_dependency "cucumber", "~> 1.3.5"
+  spec.add_development_dependency "mocha", "~> 0.14.0"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "factory_girl", "~> 4.2.0"
+  spec.add_development_dependency 'coveralls'
+
+  spec.add_dependency "savon", "~> 2.3.0"
+  spec.add_dependency "activesupport", "~> 4.0.0"
+end

data/lib/kalibro_entities.rb

@@ -0,0 +1,61 @@
+# This file is part of KalibroEntities
+# 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 'yaml'
+require 'logger'
+require "kalibro_entities/version"
+require "kalibro_entities/errors"
+require "kalibro_entities/entities"
+
+module KalibroEntities
+  @config = {
+              address: "http://localhost:8080/KalibroService/"
+            }
+
+  @valid_config_keys = @config.keys
+
+  @logger = Logger.new(STDOUT)
+
+  # Configure through hash
+  def KalibroEntities.configure(opts = {})
+    opts.each {|k,v| @config[k.to_sym] = v if @valid_config_keys.include? k.to_sym}
+  end
+
+  # Configure through yaml file
+  def KalibroEntities.configure_with(path_to_yaml_file)
+    begin
+      config = YAML::load(IO.read(path_to_yaml_file))
+    rescue Errno::ENOENT
+      logger.warn("YAML configuration file couldn't be found. Using defaults."); return
+    rescue Psych::SyntaxError
+      logger.warn("YAML configuration file contains invalid syntax. Using defaults."); return
+    end
+
+    configure(config)
+  end
+
+  def KalibroEntities.config
+    @config
+  end
+
+  def KalibroEntities.logger
+    @logger
+  end
+
+  def KalibroEntities.logger=(logger)
+    @logger = logger
+  end
+end

data/lib/kalibro_entities/entities.rb

@@ -0,0 +1,37 @@
+# This file is part of KalibroEntities
+# 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 'kalibro_entities/entities/base_tool'
+require 'kalibro_entities/entities/configuration'
+require 'kalibro_entities/entities/date_metric_result'
+require 'kalibro_entities/entities/date_module_result'
+require 'kalibro_entities/entities/metric'
+require 'kalibro_entities/entities/metric_configuration'
+require 'kalibro_entities/entities/metric_configuration_snapshot'
+require 'kalibro_entities/entities/metric_result'
+require 'kalibro_entities/entities/module'
+require 'kalibro_entities/entities/module_result'
+require 'kalibro_entities/entities/process_time'
+require 'kalibro_entities/entities/processing'
+require 'kalibro_entities/entities/project'
+require 'kalibro_entities/entities/range'
+require 'kalibro_entities/entities/range_snapshot'
+require 'kalibro_entities/entities/reading'
+require 'kalibro_entities/entities/reading_group'
+require 'kalibro_entities/entities/repository'
+require 'kalibro_entities/entities/repository_observer'
+require 'kalibro_entities/entities/stack_trace_element'
+require 'kalibro_entities/entities/throwable'

data/lib/kalibro_entities/entities/base_tool.rb

@@ -0,0 +1,54 @@
+# This file is part of KalibroEntities
+# 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 "kalibro_entities/entities/model"
+
+module KalibroEntities
+  module Entities
+    class BaseTool < Model
+      attr_accessor :name, :description, :collector_class_name, :supported_metric
+
+      def supported_metric=(value)
+        @supported_metric = KalibroEntities::Entities::Metric.to_objects_array value
+      end
+
+      def supported_metrics
+        @supported_metric
+      end
+
+      def metric(name)
+        supported_metrics.find {|metric| metric.name == name}
+      end
+
+      def self.find_by_name(base_tool_name)
+        begin
+          new request(:get_base_tool, {:base_tool_name => base_tool_name})[:base_tool]
+        rescue
+          raise KalibroEntities::Errors::RecordNotFound
+        end
+      end
+      
+      def self.all_names
+        request(:all_base_tool_names)[:base_tool_name].to_a
+      end
+
+      def self.all
+        base_tools = all_names
+        base_tools.map{ |name| find_by_name(name) }
+      end
+    end
+  end
+end

data/lib/kalibro_entities/entities/configuration.rb

@@ -0,0 +1,33 @@
+# This file is part of KalibroEntities
+# 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 "kalibro_entities/entities/model"
+
+module KalibroEntities
+  module Entities
+    class Configuration < Model
+      attr_accessor :id, :name, :description
+
+      def id=(value)
+        @id = value.to_i
+      end
+
+      def self.all
+        create_objects_array_from_hash request(:all_configurations)[:configuration]
+      end
+    end
+  end
+end

data/lib/kalibro_entities/entities/date_metric_result.rb

@@ -0,0 +1,39 @@
+# This file is part of KalibroEntities
+# 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 "kalibro_entities/entities/model"
+
+module KalibroEntities
+  module Entities
+    class DateMetricResult < Model
+      
+      attr_accessor :date, :metric_result
+
+      def date=(value)
+        @date = value.is_a?(String) ? DateTime.parse(value) : value
+      end
+
+      def metric_result=(value)
+        @metric_result = KalibroEntities::Entities::MetricResult.to_object value
+      end
+      
+      def result
+        @metric_result.value
+      end
+      
+    end
+  end
+end

data/lib/kalibro_entities/entities/date_module_result.rb

@@ -0,0 +1,39 @@
+# This file is part of KalibroEntities
+# 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 "kalibro_entities/entities/model"
+
+module KalibroEntities
+  module Entities
+    class DateModuleResult < Model
+      
+      attr_accessor :date, :module_result
+
+      def date=(value)
+        @date = value.is_a?(String) ? DateTime.parse(value) : value
+      end
+
+      def module_result=(value)
+        @module_result = KalibroEntities::Entities::ModuleResult.to_object value
+      end
+      
+      def result
+        @module_result.grade
+      end
+      
+    end
+  end
+end

data/lib/kalibro_entities/entities/metric.rb

@@ -0,0 +1,21 @@
+module KalibroEntities
+  module Entities
+    class Metric < Model
+      
+      attr_accessor :name, :compound, :scope, :description, :script, :language
+
+      def languages
+        @language
+      end
+
+      def languages=(languages)
+        @language = languages
+      end
+
+      def language=(value)
+        @language = self.class.to_objects_array value
+      end
+
+    end
+  end
+end

data/lib/kalibro_entities/entities/metric_configuration.rb

@@ -0,0 +1,70 @@
+# This file is part of KalibroEntities
+# 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 "kalibro_entities/entities/model"
+
+module KalibroEntities
+  module Entities
+    class MetricConfiguration < Model
+
+      attr_accessor :id, :code, :metric, :base_tool_name, :weight, :aggregation_form, :reading_group_id, :configuration_id
+
+      def id=(value)
+        @id = value.to_i
+      end
+      
+      def reading_group_id=(value)
+        @reading_group_id = value.to_i
+      end
+
+      def metric=(value)
+        @metric = KalibroEntities::Entities::Metric.to_object(value)
+      end
+
+      def weight=(value)
+        @weight = value.to_f
+      end
+
+      def update_attributes(attributes={})
+        attributes.each { |field, value| send("#{field}=", value) if self.class.is_valid?(field) }
+        save
+      end
+
+      def to_hash
+        super :except => [:configuration_id]
+      end
+
+      def self.find(id)
+        #TODO: on future versions of Kalibro this begin/rescue will be unnecessary
+        begin
+          new request(:get_metric_configuration, {:metric_configuration_id => id})[:metric_configuration]
+        rescue Savon::SOAPFault
+          raise KalibroEntities::Errors::RecordNotFound
+        end
+      end
+
+      def self.metric_configurations_of(configuration_id)
+        create_objects_array_from_hash request(:metric_configurations_of, {:configuration_id => configuration_id})[:metric_configuration]
+      end
+
+      private
+      
+      def save_params
+        {:metric_configuration => self.to_hash, :configuration_id => self.configuration_id}
+      end
+    end
+  end
+end