kolekti_metricfu 0.0.4

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_metricfu.gemspec
+gemspec

data/README.md

@@ -0,0 +1,34 @@
+# KolektiMetricfu
+
+[![Code Climate](https://codeclimate.com/github/mezuro/kolekti_metricfu/badges/gpa.svg)](https://codeclimate.com/github/mezuro/kolekti_metricfu) <a href="https://codeclimate.com/github/mezuro/kolekti_metricfu/coverage"><img src="https://codeclimate.com/github/mezuro/kolekti_metricfu/badges/coverage.svg" /></a>
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kolekti_metricfu'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kolekti_metricfu
+
+## 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_metricfu.
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "kolekti/metricfu"
+
+# 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_metricfu.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kolekti/metricfu/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'kolekti_metricfu'
+  spec.version       = Kolekti::Metricfu::VERSION
+  spec.authors       = ['Daniel Miranda',
+                        "Diego Araújo",
+                        "Eduardo Araújo",
+                        'Rafael Reggiani Manzo']
+  spec.email         = ['danielkza2@gmail.com',
+                        'diegoamc90@gmail.com',
+                        'duduktamg@hotmail.com',
+                        'rr.manzo@protonmail.com']
+  spec.summary       = 'Metric collecting support for Ruby that servers Kolekti.'
+  spec.homepage      = 'https://github.com/mezuro/kolekti_metricfu'
+
+  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_dependency 'kolekti', '~> 1.1'
+  spec.add_dependency 'metric_fu', '~> 4.12.0'
+  spec.add_dependency 'flog', '~> 4.3.2' # Restriction necessary until https://github.com/metricfu/metric_fu/pull/274 does not get merged, released and we update our metric_fu requirements
+  # Version 0.2.5 requires ruby >= 2.1 while CentOS 7 is still running 2.0.0
+  spec.add_dependency 'unparser', '< 0.2.5' if RUBY_VERSION < '2.1.0'
+
+  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 'simplecov'
+  spec.add_development_dependency 'codeclimate-test-reporter'
+  spec.add_development_dependency 'cucumber', '~> 2.1'
+  spec.add_development_dependency 'factory_girl', '~> 4.5'
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'rubocop', '>= 0.36'
+end

data/lib/kolekti/metricfu/collector.rb

@@ -0,0 +1,57 @@
+require 'tempfile'
+
+module Kolekti
+  module Metricfu
+    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('metric_fu --version', [:out, :err] => '/dev/null') ? true : false
+        system('metric_fu --version', out: '/dev/null', err: '/dev/null') ? true : false
+      end
+
+      def initialize
+        supported_metrics = parse_supported_metrics(
+          File.expand_path('../metrics.yml', __FILE__),
+          'MetricFu',
+          [:RUBY]
+        )
+
+        super('MetricFu', 'Set of Ruby metric tools', supported_metrics)
+      end
+
+      def collect_metrics(code_directory, wanted_metric_configurations, persistence_strategy)
+        tmp_file = Tempfile.new(['metric_fu', '.yml'], code_directory)
+        begin
+          Dir.chdir(code_directory) do
+            unless system('metric_fu', '--format', 'yaml', '--out', tmp_file.path, '--no-reek', out: '/dev/null', err: '/dev/null')
+              raise Kolekti::CollectorError.new('MetricFu failed')
+            end
+          end
+          Kolekti::Metricfu::Parsers.parse_all(tmp_file.path, wanted_metric_configurations, persistence_strategy)
+        ensure
+          tmp_file.close!
+        end
+      end
+
+      def clean(code_directory, wanted_metric_configurations)
+        # Does not need to do anything, as collect metrics cleans things up already through a rescue block
+      end
+
+      def default_value_from(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::Metricfu::Parsers::PARSERS[metric.code.to_sym]
+        end
+
+        raise Kolekti::UnavailableMetricError.new('Metric configuration does not belong to MetricFu') if parser.nil?
+
+        parser.default_value
+      end
+    end
+  end
+end

data/lib/kolekti/metricfu/metrics.yml

@@ -0,0 +1,27 @@
+:metrics:
+  #:abc:
+  #  :name: ABC complexity
+  #  :description: The ABC metric measures size/complexity by counting the number of Assignments (A), Branches (B) and Conditions (C) and assigns a single numerical score
+  #  :scope: METHOD
+
+  #:churn:
+  #  :name: Code churn
+  #  :description: Code churn is how often code is changing over time
+  #  :scope: CLASS
+
+  :flog:
+    :name: Pain
+    :description: Measures how hard (painful) it is to test the code
+    :scope: METHOD
+    :type: NativeMetricSnapshot
+
+  :saikuro:
+    :name: Cyclomatic Complexity
+    :description: Cyclomatic complexity is a graphical measurement of the number of possible paths through the normal flow of a program
+    :scope: METHOD
+    :type: NativeMetricSnapshot
+
+  :flay:
+    :name: Duplicate Code
+    :description: 'Flay analyzes code for structural similarities. Differences in literal values, variable, class, method names, whitespace, programming style, braces vs do/end, etc are all ignored'
+    :type: HotspotMetricSnapshot

data/lib/kolekti/metricfu/parsers/base.rb

@@ -0,0 +1,22 @@
+module Kolekti
+  module Metricfu
+    module Parsers
+      class Base < Kolekti::Parser
+        def self.module_name_suffix(module_name)
+          return '' if module_name.to_s.end_with?('#none')
+
+          # Replace Saikuro's representation of a class method (#self.method) with Flog's
+          # (::method) so we can treat both the same later.
+          module_name = module_name.gsub('#self.', '::')
+          # Now split up the last component of the module name so it doesn't get it's
+          # prefixes (# or ::) replaced with . (our own separator).
+          module_path, prefix, module_name = module_name.rpartition(/#|::/)
+          # Replace the separators in the path (and only the path) with dots
+          module_path.gsub!(/#|::/, '.')
+          # Put everything back together
+          '.' + module_path + '.' + prefix + module_name
+        end
+      end
+    end
+  end
+end

data/lib/kolekti/metricfu/parsers/flay.rb

@@ -0,0 +1,22 @@
+module Kolekti
+  module Metricfu
+    module Parsers
+      class Flay < Base
+        def self.parse(collected_metrics_hash, metric_configuration, persistence_strategy)
+          collected_metrics_hash[:matches].each do |match|
+            reason = match[:reason]
+            results = match[:matches].map do |line_match|
+              line_number = line_match[:line].to_i
+              module_name = parse_file_name(line_match[:name])
+              { 'module_name' => module_name,
+                'line' => line_number,
+                'message' => reason }
+            end
+
+            persistence_strategy.create_related_hotspot_metric_results(metric_configuration, results) unless results.empty?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kolekti/metricfu/parsers/flog.rb

@@ -0,0 +1,30 @@
+module Kolekti
+  module Metricfu
+    module Parsers
+      class Flog < Base
+        def self.parse(collected_metrics_hash, metric_configuration, persistence_strategy)
+          collected_metrics_hash[:method_containers].each do |method_container|
+            next if method_container[:path].nil? || method_container[:path].empty?
+            name_prefix = self.parse_file_name(method_container[:path])
+
+            method_container[:methods].each do |name, result|
+              value = result[:score]
+
+              name_suffix = module_name_suffix(name)
+
+              next if name_suffix.nil? || name_suffix.empty?
+              module_name = name_prefix + name_suffix
+              granularity = KalibroClient::Entities::Miscellaneous::Granularity::METHOD
+
+              persistence_strategy.create_tree_metric_result(metric_configuration, module_name, value.to_f, granularity)
+            end
+          end
+        end
+
+        def self.default_value
+          0.0 # No pain, no gain
+        end
+      end
+    end
+  end
+end

data/lib/kolekti/metricfu/parsers/saikuro.rb

@@ -0,0 +1,32 @@
+module Kolekti
+  module Metricfu
+    module Parsers
+      class Saikuro < Base
+        def self.parse(collected_metrics_hash, metric_configuration, persistence_strategy)
+          collected_metrics_hash[:files].each do |file|
+            name_prefix = parse_file_name(file[:filename])
+            file[:classes].each do |cls|
+              # Filter duplicate methods, picking only the latest. Fortunately Hash::[] will pick the latest element
+              # when receiveing an array.
+              methods_by_name = cls[:methods].map { |method| [method[:name], method] }
+              # FIXME: Since ruby 2.1 this can be replaced by 'methods_by_name.to_hash'
+              methods = Hash[methods_by_name]
+              methods.each_value do |method|
+                value = method[:complexity]
+                name_suffix = module_name_suffix(method[:name])
+                module_name = name_prefix + name_suffix
+
+                granularity = KalibroClient::Entities::Miscellaneous::Granularity::METHOD
+                persistence_strategy.create_tree_metric_result(metric_configuration, module_name, value.to_f, granularity)
+              end
+            end
+          end
+        end
+
+        def self.default_value
+          1.0 # Just one branch
+        end
+      end
+    end
+  end
+end

data/lib/kolekti/metricfu/parsers.rb

@@ -0,0 +1,25 @@
+require 'kolekti/metricfu/parsers/base'
+require 'kolekti/metricfu/parsers/flog'
+require 'kolekti/metricfu/parsers/saikuro'
+require 'kolekti/metricfu/parsers/flay'
+
+module Kolekti
+  module Metricfu
+    module Parsers
+      PARSERS = {
+        flog: Flog,
+        saikuro: Saikuro,
+        flay: Flay
+      }.freeze
+
+      def self.parse_all(results_yaml_path, wanted_metric_configurations, persistence_strategy)
+        parsed_result = YAML.load_file(results_yaml_path)
+
+        wanted_metric_configurations.each do |code, metric_configuration|
+          code_sym = code.to_sym
+          PARSERS[code_sym].parse(parsed_result[code_sym], metric_configuration, persistence_strategy)
+        end
+      end
+    end
+  end
+end

data/lib/kolekti/metricfu/version.rb

@@ -0,0 +1,5 @@
+module Kolekti
+  module Metricfu
+    VERSION = '0.0.4'.freeze
+  end
+end

data/lib/kolekti/metricfu.rb

@@ -0,0 +1,11 @@
+require 'kolekti'
+
+require 'kolekti/metricfu/version'
+require 'kolekti/metricfu/collector'
+require 'kolekti/metricfu/parsers'
+
+module Kolekti
+  module Metricfu
+    # Your code goes here...
+  end
+end