codacy-coverage 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ed371108f2d9c6b2f61a19b7ea7aba4e9557e194
+  data.tar.gz: 0727932b29163f3e42e9754cfbc56d21beb74bdf
+SHA512:
+  metadata.gz: a6adaf3d319cc860ac86d290900db388031ddf20f7fbb1b0b1925aa2d34493ac272661d274e9e75c7ba87f1d20de6b4db6892d8d5c3f4a6eddcea0f0ecbc1716
+  data.tar.gz: e562e27817edb1926519cc1c51ed38411be78a640c5b80338a6af2a189d6f9fba17da643c27985dfc36e3f44206c4a2f7ccbd7cc8c93601e231dbc6fdbe1c956

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+.idea/
+.idea_modules/
+
+.DS_Store
+/vendor/

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake', '>= 10.4'
+gem 'rspec', '>= 3.2'
+gem 'simplecov', :require => false
+gem 'rest-client'

data/codacy-coverage.gemspec

@@ -0,0 +1,24 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Nuno Teixeira"]
+  gem.email         = ["nuno@codacy.com"]
+  gem.description   = "Post code coverage results to Codacy."
+  gem.summary       = "Post code coverage results to Codacy."
+  gem.homepage      = "https://codacy.com"
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "codacy-coverage"
+  gem.require_paths = ["lib"]
+  gem.version       = '0.0.1'
+
+  gem.required_ruby_version = '>= 1.8.7'
+
+  gem.add_dependency 'simplecov', '~> 0.10.0'
+
+  gem.add_development_dependency 'bundler', '~> 1.7'
+end

data/lib/codacy-coverage.rb

@@ -0,0 +1,6 @@
+require "codacy/configuration"
+require "codacy/reporter"
+require "codacy/client"
+require "codacy/formatter"
+require "codacy/git"
+require "codacy/parser"

data/lib/codacy/client.rb

@@ -0,0 +1,52 @@
+require 'json'
+require 'rest_client'
+
+module Codacy
+  module ClientAPI
+    def self.post_results(parsed_result)
+      logger.info('Preparing payload...')
+      logger.debug(parsed_result)
+
+      project_token = ENV['CODACY_PROJECT_TOKEN']
+      codacy_base_api = ENV['CODACY_BASE_API_URL'] || 'https://api.codacy.com'
+      commit = Codacy::Git.commit_id
+      url = codacy_base_api + '/2.0/coverage/' + commit + '/ruby'
+
+      result = parsed_result.to_json
+
+      if project_token.to_s == ''
+        logger.error 'Could not find Codacy API token, make sure you have it configured in your environment.'
+        false
+      elsif commit.to_s == ''
+        logger.error 'Could not find the current commit, make sure that you are running inside a git project.'
+        false
+      else
+        logger.info('Posting ' + result.to_s.bytes.length.to_s + ' bytes to ' + url)
+        response = send_request(url, result, project_token)
+
+        logger.info(response)
+        response.to_s.include? 'success'
+      end
+    end
+
+    def self.send_request(url, request, project_token, redirects = 3)
+      RestClient.post(
+          url,
+          request,
+          'project_token' => project_token,
+          :content_type => :json
+      ) do |resp, req, result, &block|
+        if [301, 302, 307].include? resp.code and redirects > 0
+          redirected_url = resp.headers[:location]
+          send_request(redirected_url, req, project_token, redirects - 1)
+        else
+          resp.return!(req, result, &block)
+        end
+      end
+    end
+
+    def self.logger
+      Codacy::Configuration.logger
+    end
+  end
+end

data/lib/codacy/configuration.rb

@@ -0,0 +1,40 @@
+require 'logger'
+require 'tmpdir'
+
+module Codacy
+  module Configuration
+
+    def self.logger
+      log_filename = self.temp_dir + 'codacy-coverage_' + Date.today.to_s + '.log'
+      log_file = File.open(log_filename, 'a')
+
+      logger_file = Logger.new(log_file)
+      logger_file.level = Logger::DEBUG
+
+      logger_stdout = Logger.new(STDOUT)
+      logger_stdout.level = Logger::INFO
+
+      log = MultiLogger.new(logger_stdout, logger_file)
+
+      log
+    end
+
+    def self.temp_dir
+      directory_name = Dir.tmpdir + "/codacy-coverage/"
+      Dir.mkdir(directory_name) unless File.exists?(directory_name)
+      directory_name
+    end
+
+    class MultiLogger
+      def initialize(*targets)
+        @targets = targets
+      end
+
+      %w(log debug info warn error fatal unknown).each do |m|
+        define_method(m) do |*args|
+          @targets.map { |t| t.send(m, *args) }
+        end
+      end
+    end
+  end
+end

data/lib/codacy/formatter.rb

@@ -0,0 +1,19 @@
+module Codacy
+  class Formatter
+
+    def format(result)
+      parse_result = Codacy::Parser.parse_file(result)
+      Codacy::ClientAPI.post_results(parse_result)
+    rescue => ex
+      logger.fatal(ex)
+      false
+    end
+
+    private
+
+    def logger
+      Codacy::Configuration.logger
+    end
+
+  end
+end

data/lib/codacy/git.rb

@@ -0,0 +1,30 @@
+module Codacy
+  class Git
+    def self.commit_id
+
+      commit = ENV['TRAVIS_COMMIT'] ||
+          ENV['DRONE_COMMIT'] ||
+          ENV['GIT_COMMIT'] ||
+          ENV['CIRCLE_SHA1'] ||
+          ENV['CI_COMMIT_ID'] ||
+          ENV['WERCKER_GIT_COMMIT'] ||
+          git_commit
+
+      commit
+    end
+
+    private
+
+    def self.git_commit
+      git("log -1 --pretty=format:'%H'")
+    end
+
+    def self.git_dir
+      return Dir.pwd
+    end
+
+    def self.git(command)
+      `git --git-dir="#{git_dir}/.git" #{command}`
+    end
+  end
+end

data/lib/codacy/parser.rb

@@ -0,0 +1,39 @@
+module Codacy
+  module Parser
+
+    def self.parse_file(simplecov_result)
+      project_dir = Dir.pwd
+
+      logger.info("Parsing simplecov result to Codacy format...")
+      logger.debug(simplecov_result.original_result)
+
+      file_reports = simplecov_result.original_result.map do |k, v|
+        file_dir = k.sub(project_dir, "").sub("/", "")
+        coverage_lines = v.each_with_index.map do |covered, lineNr|
+          if !covered.nil? && covered > 0
+            [(lineNr + 1).to_s, covered]
+          else
+            nil
+          end
+        end.compact
+        lines_covered = v.compact.length == 0 ? 0 : ((coverage_lines.length.to_f / v.compact.length) * 100).round
+        Hash[
+            [['filename', file_dir],
+             ['total', lines_covered],
+             ['coverage', Hash[coverage_lines]]]
+        ]
+      end
+
+      total = simplecov_result.source_files.covered_percent.round
+
+      Hash[[['total', total], ['fileReports', file_reports]]]
+    end
+
+
+    private
+
+    def self.logger
+      Codacy::Configuration.logger
+    end
+  end
+end

data/lib/codacy/reporter.rb

@@ -0,0 +1,10 @@
+require 'simplecov'
+
+module Codacy
+  module Reporter
+    def self.start
+      SimpleCov.formatter = Codacy::Formatter
+      SimpleCov.start
+    end
+  end
+end

data/ruby-codacy-coverage.iml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="RUBY_MODULE" version="4">
+  <component name="NewModuleRootManager" inherit-compiler-output="true">
+    <exclude-output />
+    <content url="file://$MODULE_DIR$" />
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

data/spec/codacy/git_spec.rb

@@ -0,0 +1,18 @@
+require "spec_helper"
+
+describe Codacy::Git do
+  describe 'commit hash' do
+    it 'recognizes CI environment variable.' do
+      expected_git_hash = "123456789"
+
+      original_val = ENV['TRAVIS_COMMIT']
+      ENV['TRAVIS_COMMIT'] = expected_git_hash
+
+      result = Codacy::Git.commit_id
+
+      ENV['TRAVIS_COMMIT'] = original_val
+
+      expect(result).to eq expected_git_hash
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'simplecov'
+
+class InceptionFormatter
+  def format(result)
+    Codacy::Formatter.new.format(result)
+  end
+end
+
+SimpleCov.formatter = InceptionFormatter
+SimpleCov.start
+
+require 'codacy-coverage'

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: codacy-coverage
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nuno Teixeira
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+description: Post code coverage results to Codacy.
+email:
+- nuno@codacy.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- codacy-coverage.gemspec
+- lib/codacy-coverage.rb
+- lib/codacy/client.rb
+- lib/codacy/configuration.rb
+- lib/codacy/formatter.rb
+- lib/codacy/git.rb
+- lib/codacy/parser.rb
+- lib/codacy/reporter.rb
+- ruby-codacy-coverage.iml
+- spec/codacy/git_spec.rb
+- spec/spec_helper.rb
+homepage: https://codacy.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Post code coverage results to Codacy.
+test_files:
+- spec/codacy/git_spec.rb
+- spec/spec_helper.rb