ashtonw-slather 1.8.2

data/lib/slather.rb

@@ -0,0 +1,20 @@
+require 'slather/version'
+require 'slather/project'
+require 'slather/coverage_file'
+require 'slather/coveralls_coverage_file'
+require 'slather/coverage_service/cobertura_xml_output'
+require 'slather/coverage_service/coveralls'
+require 'slather/coverage_service/hardcover'
+require 'slather/coverage_service/gutter_json_output'
+require 'slather/coverage_service/simple_output'
+require 'slather/coverage_service/html_output'
+
+module Slather
+
+  Encoding.default_external = "utf-8"
+
+  def self.prepare_pods(pods)
+    Pod::UI.warn("[Slather] prepare_pods is now deprecated. The call to prepare_pods in your Podfile can simply be ommitted.")
+  end
+
+end

data/lib/slather/coverage_file.rb

@@ -0,0 +1,195 @@
+module Slather
+  class CoverageFile
+
+    attr_accessor :project, :gcno_file_pathname
+
+    def initialize(project, gcno_file_pathname)
+      self.project = project
+      self.gcno_file_pathname = Pathname(gcno_file_pathname)
+    end
+
+    def source_file_pathname
+      @source_file_pathname ||= begin
+        base_filename = gcno_file_pathname.basename.sub_ext("")
+        # TODO: Handle Swift
+        path = nil
+        if project.source_directory
+          path = Dir["#{project.source_directory}/**/#{base_filename}.{#{supported_file_extensions.join(",")}}"].first
+          path &&= Pathname(path)
+        else
+          pbx_file = project.files.detect { |pbx_file|
+            current_base_filename = pbx_file.real_path.basename
+            ext_name = File.extname(current_base_filename.to_s)[1..-1]
+            current_base_filename.sub_ext("") == base_filename && supported_file_extensions.include?(ext_name)
+          }
+          path = pbx_file && pbx_file.real_path
+        end
+        path
+      end
+    end
+
+    def source_file
+      File.new(source_file_pathname)
+    end
+
+    def source_data
+      source_file.read
+    end
+
+    def source_file_pathname_relative_to_repo_root
+      source_file_pathname.realpath.relative_path_from(Pathname("./").realpath)
+    end
+
+    def gcov_data
+      @gcov_data ||= begin
+        gcov_output = `gcov "#{source_file_pathname}" --object-directory "#{gcno_file_pathname.parent}" --branch-probabilities --branch-counts`
+        # Sometimes gcov makes gcov files for Cocoa Touch classes, like NSRange. Ignore and delete later.
+        gcov_files_created = gcov_output.scan(/creating '(.+\..+\.gcov)'/)
+
+        gcov_file_name = "./#{source_file_pathname.basename}.gcov"
+        if File.exists?(gcov_file_name)
+          gcov_data = File.new(gcov_file_name).read
+        else
+          gcov_data = ""
+        end
+
+        gcov_files_created.each { |file| FileUtils.rm_f(file) }
+        gcov_data
+      end
+    end
+
+    def line_coverage_data
+      unless cleaned_gcov_data.empty?
+        first_line_start = cleaned_gcov_data =~ /^\s+(-|#+|[0-9+]):\s+1:/
+
+        cleaned_gcov_data[first_line_start..-1].split("\n").map do |line|
+          coverage_for_line(line)
+        end
+      else
+        []
+      end
+    end
+
+    def cleaned_gcov_data
+      data = gcov_data.encode('UTF-8', 'binary', invalid: :replace, undef: :replace, replace: '').gsub(/^function(.*) called [0-9]+ returned [0-9]+% blocks executed(.*)$\r?\n/, '')
+      data.gsub(/^branch(.*)$\r?\n/, '')
+    end
+
+    def coverage_for_line(line)
+      line =~ /^(.+?):/
+
+      match = $1.strip
+      case match
+      when /[0-9]+/
+        match.to_i
+      when /#+/
+        0
+      when "-"
+        nil
+      end
+    end
+
+    def num_lines_tested
+      line_coverage_data.compact.select { |cd| cd > 0 }.count
+    end
+
+    def num_lines_testable
+      line_coverage_data.compact.count
+    end
+
+    def rate_lines_tested
+      if num_lines_testable > 0
+        (num_lines_tested / num_lines_testable.to_f)
+      else
+        0
+      end
+    end
+
+    def percentage_lines_tested
+      if num_lines_testable == 0
+        100
+      else
+        rate_lines_tested * 100
+      end
+    end
+
+    def branch_coverage_data
+      @branch_coverage_data ||= begin
+        branch_coverage_data = Hash.new
+
+          gcov_data.scan(/(^(\s+(-|#+|[0-9]+):\s+[1-9]+:(.*)$\r?\n)(^branch\s+[0-9]+\s+[a-zA-Z0-9]+\s+[a-zA-Z0-9]+$\r?\n)+)+/) do |data|
+            lines = data[0].split("\n")
+            line_number = lines[0].split(':')[1].strip.to_i
+            branch_coverage_data[line_number] = lines[1..-1].map do |line|
+              if line.split(' ')[2].strip == "never"
+                0
+              else
+                line.split(' ')[3].strip.to_i
+              end
+            end
+          end
+        branch_coverage_data
+      end
+    end
+
+    def branch_coverage_data_for_statement_on_line(line_number)
+      branch_coverage_data[line_number] || []
+    end
+
+    def num_branches_for_statement_on_line(line_number)
+      branch_coverage_data_for_statement_on_line(line_number).length
+    end
+
+    def num_branch_hits_for_statement_on_line(line_number)
+      branch_coverage_data_for_statement_on_line(line_number).count { |hit_count| hit_count > 0 }
+    end
+
+    def rate_branch_coverage_for_statement_on_line(line_number)
+      branch_data = branch_coverage_data_for_statement_on_line(line_number)
+      if branch_data.empty?
+        0.0
+      else
+        (num_branch_hits_for_statement_on_line(line_number) / branch_data.length.to_f)
+      end
+    end
+
+    def percentage_branch_coverage_for_statement_on_line(line_number)
+      rate_branch_coverage_for_statement_on_line(line_number) * 100
+    end
+
+    def num_branches_testable
+      branch_coverage_data.keys.reduce(0) do |sum, line_number|
+        sum += num_branches_for_statement_on_line(line_number)
+      end
+    end
+
+    def num_branches_tested
+      branch_coverage_data.keys.reduce(0) do |sum, line_number|
+        sum += num_branch_hits_for_statement_on_line(line_number)
+      end
+    end
+
+    def rate_branches_tested
+      if (num_branches_testable > 0)
+        (num_branches_tested / num_branches_testable.to_f)
+      else
+        0.0
+      end
+    end
+
+    def source_file_basename
+      File.basename(source_file_pathname, '.m')
+    end
+
+    def ignored?
+      project.ignore_list.any? do |ignore|
+        File.fnmatch(ignore, source_file_pathname_relative_to_repo_root)
+      end
+    end
+
+    def supported_file_extensions
+      ["cpp", "mm", "m"]
+    end
+    private :supported_file_extensions
+  end
+end

data/lib/slather/coverage_service/cobertura_xml_output.rb

@@ -0,0 +1,183 @@
+require 'nokogiri'
+
+module Slather
+  module CoverageService
+    module CoberturaXmlOutput
+
+      def coverage_file_class
+        Slather::CoverageFile
+      end
+      private :coverage_file_class
+
+      def post
+        cobertura_xml_report = create_xml_report(coverage_files)
+        store_report(cobertura_xml_report)
+      end
+
+      def store_report(report)
+        output_file = 'cobertura.xml'
+        if output_directory
+          FileUtils.mkdir_p(output_directory)
+          output_file = File.join(output_directory, output_file)
+        end
+        File.write(output_file, report.to_s)
+      end
+
+      def grouped_coverage_files
+        groups = Hash.new
+        coverage_files.each do |coverage_file|
+          path = File.dirname(coverage_file.source_file_pathname_relative_to_repo_root)
+          if groups[path] == nil
+            groups[path] = Array.new
+          end
+          groups[path].push(coverage_file)
+        end
+        groups
+      end
+
+      def create_xml_report(coverage_files)
+        total_project_lines = 0
+        total_project_lines_tested = 0
+        total_project_line_rate = '%.16f' % 1.0
+        total_project_branches = 0
+        total_project_branches_tested = 0
+        total_project_branch_rate = '%.16f' % 1.0
+
+        create_empty_xml_report
+        coverage_node = @doc.root
+        source_node = @doc.at_css "source" 
+        source_node.content = Pathname.pwd.to_s
+        packages_node = @doc.at_css "packages"
+
+        # group files by path
+        grouped_coverage_files.each do |path , package_coverage_files|
+          package_node = Nokogiri::XML::Node.new "package", @doc
+          package_node.parent = packages_node
+          classes_node = Nokogiri::XML::Node.new "classes", @doc
+          classes_node.parent = package_node
+          package_node['name'] = path.gsub(/\//, '.')
+
+          total_package_lines = 0
+          total_package_lines_tested = 0
+          total_package_lines_rate = '%.16f' % 1.0
+          total_package_branches = 0
+          total_package_branches_tested = 0
+          total_package_branch_rate = '%.16f' % 1.0
+
+          package_coverage_files.each do |package_coverage_file|
+            class_node = create_class_node(package_coverage_file)
+            class_node.parent = classes_node
+            total_package_lines += package_coverage_file.num_lines_testable
+            total_package_lines_tested += package_coverage_file.num_lines_tested
+            total_package_branches += package_coverage_file.num_branches_testable
+            total_package_branches_tested += package_coverage_file.num_branches_tested
+          end
+
+          if (total_package_lines > 0)
+            total_package_line_rate = '%.16f' % (total_package_lines_tested / total_package_lines.to_f)
+          end
+
+          if (total_package_branches > 0)
+            total_package_branch_rate = '%.16f' % (total_package_branches_tested / total_package_branches.to_f)
+          end
+
+          package_node['line-rate'] = total_package_line_rate
+          package_node['branch-rate'] = total_package_branch_rate
+          package_node['complexity'] = '0.0'
+
+          total_project_lines += total_package_lines
+          total_project_lines_tested += total_package_lines_tested
+          total_project_branches += total_package_branches
+          total_project_branches_tested += total_package_branches_tested
+        end
+
+        if (total_project_lines > 0)
+          total_project_line_rate = '%.16f' % (total_project_lines_tested / total_project_lines.to_f)
+        end
+
+        if (total_project_branches > 0)
+          total_project_branch_rate = '%.16f' % (total_project_branches_tested / total_project_branches.to_f)
+        end
+
+        coverage_node['line-rate'] = total_project_line_rate
+        coverage_node['branch-rate'] = total_project_branch_rate
+        coverage_node['lines-covered'] = total_project_lines_tested
+        coverage_node['lines-valid'] = total_project_lines
+        coverage_node['branches-covered'] = total_project_branches_tested
+        coverage_node['branches-valid'] = total_project_branches
+        coverage_node['complexity'] = "0.0"
+        coverage_node['timestamp'] = DateTime.now.strftime('%s')
+        coverage_node['version'] = "Slather #{Slather::VERSION}"
+        @doc.to_xml
+      end
+
+      def create_class_node(coverage_file)
+        filename = coverage_file.source_file_basename
+        filepath = coverage_file.source_file_pathname_relative_to_repo_root.to_s
+
+        class_node = Nokogiri::XML::Node.new "class", @doc
+        class_node['name'] = filename
+        class_node['filename'] = filepath
+        class_node['line-rate'] = '%.16f' %  [(coverage_file.num_lines_testable > 0) ? coverage_file.rate_lines_tested : 1.0]
+        class_node['branch-rate'] = '%.16f' % [(coverage_file.num_branches_testable > 0) ? coverage_file.rate_branches_tested : 1.0]
+        class_node['complexity'] = '0.0'
+
+        methods_node = Nokogiri::XML::Node.new "methods", @doc
+        methods_node.parent = class_node
+        lines_node = Nokogiri::XML::Node.new "lines", @doc
+        lines_node.parent = class_node
+        
+        coverage_file.cleaned_gcov_data.split("\n").each do |line|
+          line_segments = line.split(':')
+          if coverage_file.coverage_for_line(line)
+            line_node = create_line_node(line, coverage_file)
+            line_node.parent = lines_node
+          end
+        end
+        class_node
+      end
+
+      def create_line_node(line, coverage_file)
+        line_number = line.split(':')[1].strip.to_i
+        line_node = Nokogiri::XML::Node.new "line", @doc
+        line_node['number'] = line_number
+        line_node['branch'] = "false"
+        line_node['hits'] = coverage_file.coverage_for_line(line)
+      
+        unless coverage_file.branch_coverage_data_for_statement_on_line(line_number).empty?
+          line_node['branch'] = "true"  
+          conditions_node = Nokogiri::XML::Node.new "conditions", @doc
+          conditions_node.parent = line_node
+          condition_node = Nokogiri::XML::Node.new "condition", @doc
+          condition_node.parent = conditions_node
+          condition_node['number'] = "0"
+          condition_node['type'] = "jump"
+          branches_testable = coverage_file.num_branches_for_statement_on_line(line_number)
+          branch_hits = coverage_file.num_branch_hits_for_statement_on_line(line_number)
+          condition_coverage = coverage_file.percentage_branch_coverage_for_statement_on_line(line_number)
+          condition_node['coverage'] = "#{condition_coverage.to_i}%"
+          line_node['condition-coverage'] = "#{condition_coverage.to_i}% (#{branch_hits}/#{branches_testable})"
+        end
+        line_node
+      end
+
+      def create_empty_xml_report
+        builder = Nokogiri::XML::Builder.new do |xml|
+          xml.doc.create_internal_subset(
+            'coverage',
+            nil,
+            "http://cobertura.sourceforge.net/xml/coverage-04.dtd"
+          )
+          xml.coverage do
+            xml.sources do
+              xml.source
+            end
+            xml.packages
+          end
+        end
+        @doc = builder.doc
+      end
+
+    end
+  end
+end

data/lib/slather/coverage_service/coveralls.rb

@@ -0,0 +1,186 @@
+module Slather
+  module CoverageService
+    module Coveralls
+
+      def coverage_file_class
+        Slather::CoverallsCoverageFile
+      end
+      private :coverage_file_class
+
+      def travis_job_id
+        ENV['TRAVIS_JOB_ID']
+      end
+      private :travis_job_id
+
+      def circleci_job_id
+        ENV['CIRCLE_BUILD_NUM']
+      end
+      private :circleci_job_id
+
+      def circleci_pull_request
+        ENV['CIRCLE_PR_NUMBER'] || ENV['CI_PULL_REQUEST'] || ""
+      end
+      private :circleci_pull_request
+
+      def jenkins_job_id
+        ENV['BUILD_ID']
+      end
+      private :jenkins_job_id
+
+      def jenkins_branch_name
+        branch_name = ENV['GIT_BRANCH']
+        if branch_name.include? 'origin/'
+          branch_name[7...branch_name.length]
+        else
+          branch_name
+        end
+      end
+      private :jenkins_branch_name
+
+      def buildkite_job_id
+        ENV['BUILDKITE_BUILD_NUMBER']
+      end
+      private :buildkite_job_id
+
+      def buildkite_pull_request
+        ENV['BUILDKITE_PULL_REQUEST']
+      end
+      private :buildkite_pull_request
+
+      def jenkins_git_info
+        {
+          head: {
+            id: ENV['sha1'],
+            author_name: ENV['ghprbActualCommitAuthor'],
+            message: ENV['ghprbPullTitle']
+          },
+          branch: jenkins_branch_name
+        }
+      end
+      private :jenkins_git_info
+
+      def circleci_build_url
+        "https://circleci.com/gh/" + ENV['CIRCLE_PROJECT_USERNAME'] || "" + "/" + ENV['CIRCLE_PROJECT_REPONAME'] || "" + "/" + ENV['CIRCLE_BUILD_NUM'] || ""
+      end
+      private :circleci_build_url
+
+      def circleci_git_info
+        {
+          :head => {
+            :id => (ENV['CIRCLE_SHA1'] || ""),
+            :author_name => (ENV['CIRCLE_PR_USERNAME'] || ENV['CIRCLE_USERNAME'] || ""),
+            :message => (`git log --format=%s -n 1 HEAD`.chomp || "")
+          },
+          :branch => (ENV['CIRCLE_BRANCH'] || "")
+        }
+      end
+      private :circleci_git_info
+
+      def buildkite_git_info
+        {
+          :head => {
+            :id => ENV['BUILDKITE_COMMIT'],
+            :author_name => (`git log --format=%an -n 1 HEAD`.chomp || ""),
+            :author_email => (`git log --format=%ae -n 1 HEAD`.chomp || ""),
+            :message => (`git log --format=%s -n 1 HEAD`.chomp || "")
+          },
+          :branch => ENV['BUILDKITE_BRANCH']
+        }
+      end
+
+      def buildkite_build_url
+        "https://buildkite.com/" + ENV['BUILDKITE_PROJECT_SLUG'] + "/builds/" + ENV['BUILDKITE_BUILD_NUMBER'] + "#"
+      end
+
+      def coveralls_coverage_data
+        if ci_service == :travis_ci || ci_service == :travis_pro
+          if travis_job_id
+            if ci_service == :travis_ci
+              {
+                :service_job_id => travis_job_id,
+                :service_name => "travis-ci",
+                :source_files => coverage_files.map(&:as_json)
+              }.to_json
+            elsif ci_service == :travis_pro
+              {
+                :service_job_id => travis_job_id,
+                :service_name => "travis-pro",
+                :repo_token => coverage_access_token,
+                :source_files => coverage_files.map(&:as_json)
+              }.to_json
+            end
+          else
+            raise StandardError, "Environment variable `TRAVIS_JOB_ID` not set. Is this running on a travis build?"
+          end
+        elsif ci_service == :circleci
+          if circleci_job_id
+            coveralls_hash = {
+              :service_job_id => circleci_job_id,
+              :service_name => "circleci",
+              :repo_token => coverage_access_token,
+              :source_files => coverage_files.map(&:as_json),
+              :git => circleci_git_info,
+              :service_build_url => circleci_build_url
+            }
+
+            if circleci_pull_request != nil && circleci_pull_request.length > 0
+              coveralls_hash[:service_pull_request] = circleci_pull_request.split("/").last
+            end
+
+            coveralls_hash.to_json
+          else
+            raise StandardError, "Environment variable `CIRCLE_BUILD_NUM` not set. Is this running on a circleci build?"
+          end
+        elsif ci_service == :jenkins
+          if jenkins_job_id
+            {
+              service_job_id: jenkins_job_id,
+              service_name: "jenkins",
+              repo_token: coverage_access_token,
+              source_files: coverage_files.map(&:as_json),
+              git: jenkins_git_info
+            }.to_json
+          else
+            raise StandardError, "Environment variable `BUILD_ID` not set. Is this running on a jenkins build?"
+          end
+        elsif ci_service == :buildkite
+          if buildkite_job_id
+            {
+              :service_job_id => buildkite_job_id,
+              :service_name => "buildkite",
+              :repo_token => coverage_access_token,
+              :source_files => coverage_files.map(&:as_json),
+              :git => buildkite_git_info,
+              :service_build_url => buildkite_build_url,
+              :service_pull_request => buildkite_pull_request
+            }.to_json
+          else
+            raise StandardError, "Environment variable `BUILDKITE_BUILD_NUMBER` not set. Is this running on a buildkite build?"
+          end
+        else
+          raise StandardError, "No support for ci named #{ci_service}"
+        end
+      end
+      private :coveralls_coverage_data
+
+      def post
+        f = File.open('coveralls_json_file', 'w+')
+        begin
+          f.write(coveralls_coverage_data)
+          f.close
+          `curl -s --form json_file=@#{f.path} #{coveralls_api_jobs_path}`
+        rescue StandardError => e
+          FileUtils.rm(f)
+          raise e
+        end
+        FileUtils.rm(f)
+      end
+
+      def coveralls_api_jobs_path
+        "https://coveralls.io/api/v1/jobs"
+      end
+      private :coveralls_api_jobs_path
+
+    end
+  end
+end