kolekti_radon 5.0.0

data/COPYING.LESSER

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in kolekti_radon.gemspec
+gemspec

data/README.md

@@ -0,0 +1,36 @@
+# KolektiRadon
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/kolekti_radon`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kolekti_radon'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kolekti_radon
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/kolekti_radon.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+# Copied from https://github.com/cucumber/cucumber-ruby/blob/master/Rakefile#L6
+$:.unshift(File.dirname(__FILE__) + '/lib')
+Dir['gem_tasks/**/*.rake'].each { |rake| load rake }
+
+task :default => [:spec, :cucumber]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "kolekti_radon"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gem_tasks/cucumber.rake

@@ -0,0 +1,10 @@
+# Copied from https://github.com/cucumber/cucumber-ruby/blob/master/gem_tasks/cucumber.rake
+
+require 'cucumber/rake/task'
+require 'cucumber/platform'
+
+Cucumber::Rake::Task.new(:features) do |t|
+  t.fork = true
+end
+
+task :cucumber => :features

data/kolekti_radon.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+version = File.read(File.expand_path('../../VERSION', __dir__)).strip
+
+Gem::Specification.new do |spec|
+  spec.name          = "kolekti_radon"
+  spec.version       = version
+  spec.authors       = ["Diego Araújo", "Daniel Miranda", "Rafael Reggiani Manzo"]
+  spec.email         = ["diegoamc@protonmail.ch", "danielkza2@gmail.com", "rr.manzo@protonmail.com"]
+
+  spec.summary       = %q{Metric collecting support for Python that serves Kolekti.}
+  spec.homepage      = "https://gitlab.com/mezuro/mezuro/tree/master/kalibro/kolekti_radon.git"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "cucumber", "~> 2.1"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "codeclimate-test-reporter", '< 1.0.0'
+  spec.add_development_dependency "factory_girl"
+  spec.add_development_dependency "byebug"
+
+  spec.add_dependency "kolekti"
+end

data/lib/kolekti/radon.rb

@@ -0,0 +1,7 @@
+require "kolekti"
+require "kolekti/radon/version"
+require "kolekti/radon/collector"
+
+module Kolekti
+  module Radon; end
+end

data/lib/kolekti/radon/collector.rb

@@ -0,0 +1,96 @@
+require 'kolekti/radon/parser'
+
+module Kolekti
+  module Radon
+    class Collector < Kolekti::Collector
+      def self.available?
+        # FIXME: below is the better form of writing this, but it does not look compatible with ruby 2.1.5 and 2.0.0
+        # system('radon', '--version', [:out, :err] => '/dev/null') ? true : false
+        system('radon', '--version', out: '/dev/null', err: '/dev/null') ? true : false
+      end
+
+      def self.logger
+        if @logger.nil?
+          @logger = Logger.new(STDERR)
+          @logger.progname = 'kolekti/radon'
+        end
+
+        @logger
+      end
+
+      def initialize
+        supported_metrics = parse_supported_metrics(
+          File.expand_path('../metrics.yml', __FILE__), 'Radon', [:PYTHON])
+
+        super('Radon', 'Set of Python metric tools', supported_metrics)
+      end
+
+      def collect_metrics(code_directory, wanted_metric_configurations, persistence_strategy)
+        parsers_metric_configurations = Hash.new { |hash, key| hash[key] = [] }
+
+        wanted_metric_configurations.each_value do |metric_configuration|
+          parser = metric_configuration_parser(metric_configuration)
+          parsers_metric_configurations[parser] << metric_configuration
+        end
+
+        parsers_metric_configurations.each do |parser_class, metric_configurations|
+          parser = parser_class.new(metric_configurations, persistence_strategy, self.class.logger)
+          run_radon(code_directory, parser)
+        end
+      end
+
+      def clean(code_directory, wanted_metric_configurations)
+        # no need to do anything, we only use pipes during collection
+      end
+
+
+      def default_value_from(metric_configuration)
+        metric_configuration_parser(metric_configuration).default_value
+      end
+
+      private
+
+      def run_radon(code_directory, parser)
+        io = IO.popen(['radon', parser.command, '.', '--json'], chdir: code_directory)
+
+        begin
+          results = JSON.load(io)
+        rescue JSON::JSONError, IOError
+          raise Kolekti::CollectorError.new('Error while parsing Radon output')
+        ensure
+          io.close
+          status = last_process_exitstatus
+        end
+
+        raise Kolekti::CollectorError.new("Radon failed") if status != 0
+
+        parser.parse(results)
+      end
+
+      # Work around the lack of any sane way to mock $? in tests by splitting it up into a separate method
+      #:nocov:
+      def last_process_exitstatus
+        $?.exitstatus
+      end
+      #:nocov:
+
+      def metric_configuration_parser(metric_configuration)
+        metric = metric_configuration.metric
+        if metric.type != 'NativeMetricSnapshot'
+          raise Kolekti::UnavailableMetricError.new('Invalid Metric configuration type')
+        end
+
+        parser = nil
+        if metric.metric_collector_name == self.name
+          parser = Kolekti::Radon::Parser::PARSERS[metric.code.to_sym]
+        end
+
+        if parser.nil?
+          raise Kolekti::UnavailableMetricError.new('Metric configuration does not belong to Radon')
+        end
+
+        parser
+      end
+    end
+  end
+end

data/lib/kolekti/radon/metrics.yml

@@ -0,0 +1,49 @@
+:metrics:
+  :cc:
+    :name: Cyclomatic Complexity
+    :description: Cyclomatic complexity is a quantitative measure of the number of linearly independent paths through a program's source code.
+    :scope: METHOD
+    :type: NativeMetricSnapshot
+
+  :mi:
+    :name: Maintainability Index
+    :description: Measures how easy it is to maintain the code.
+    :scope: PACKAGE
+    :type: NativeMetricSnapshot
+
+  :loc:
+    :name: Lines of code
+    :description: The total number of lines of code.
+    :scope: PACKAGE
+    :type: NativeMetricSnapshot
+
+  :lloc:
+    :name: Logical Lines of code
+    :description: The number of logical lines of code. Every logical line of code contains exactly one statement.
+    :scope: PACKAGE
+    :type: NativeMetricSnapshot
+
+  :sloc:
+    :name: Source Lines of code
+    :description: The number of source lines of code not necessarily corresponding to the logical one.
+    :scope: PACKAGE
+    :type: NativeMetricSnapshot
+
+  :comments:
+    :name: Number of comment lines
+    :description: The number of comment lines. Multiline strings are not counted as comment since to the Python interpreters they are just strings.
+    :scope: PACKAGE
+    :type: NativeMetricSnapshot
+
+  :multi:
+    :name: Multi-line strings
+    :description: The number of lines which represent multi-line strings.
+    :scope: PACKAGE
+    :type: NativeMetricSnapshot
+
+  :blank:
+    :name: Number of blank lines
+    :description: The number of blank lines containing just white spaces.
+    :scope: PACKAGE
+    :type: NativeMetricSnapshot
+

data/lib/kolekti/radon/parser.rb

@@ -0,0 +1,23 @@
+require 'kolekti/parser'
+require 'kolekti/radon/parser/base'
+require 'kolekti/radon/parser/cyclomatic'
+require 'kolekti/radon/parser/maintainability'
+require 'kolekti/radon/parser/raw'
+
+module Kolekti
+  module Radon
+    module Parser
+      PARSERS = {
+        :cc       => Cyclomatic,
+        :mi       => Maintainability,
+        :loc      => Raw,
+        :lloc     => Raw,
+        :sloc     => Raw,
+        :multi    => Raw,
+        :blank    => Raw,
+        :comments => Raw,
+      }
+    end
+  end
+end
+