slather 2.2.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eeb8cebaec1537b632d62c19245da2c00af5730e
-  data.tar.gz: 0b7ca2c1e79d283e9899b969012f943d611ed0be
+  metadata.gz: 8096ea189a9cebaad5a72f45dce58fd1f9f6b284
+  data.tar.gz: 15d24647aeba911b4e194dd150ea9700335fe21c
 SHA512:
-  metadata.gz: 81c1fd17cba7d152635a93aaf546bd1cfa9fc1040dd92da8b690486a913178e254ce28ae753200d2bc171cad0d586f2304a4b21d6683e364cc321bb77c88f0e0
-  data.tar.gz: 3f0a80e2845b883f7ed3867a68f5717da9d85ea62bfa07442195017b735e21e667a244cf90924cb99a43193d8256d2293f48bc6f5aa9cef6570d856537c3befd
+  metadata.gz: 311d63ca7b84e89bbdda3f1f0a0d7063df7c2e890ca96bb9a81d3aead8263ee14a18b0264d506107600d0985cf4fa3519527d2808ea3a169b21b5d9ba4c739fc
+  data.tar.gz: e138521b5d249354893eb05c24a88edf245cf649d1c0338aa3e757721bd9e7127132ae5b84d456e1562b58ec7b32b1f574149763c74eb4e7b14d8d10e5cb7365

data/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 ## master
 
+## v2.2.1
+
+* Make `project.coverage_files` public  
+* Add docs attribute reader to `project.rb`  
+  [bootstraponline](https://github.com/bootstraponline)
+  [#209](https://github.com/SlatherOrg/slather/pull/209)
+
+* Add `--decimals` flag  
+  [bootstraponline](https://github.com/bootstraponline)
+  [#207](https://github.com/SlatherOrg/slather/pull/207)
+
+* Add `slather version` command  
+  [bootstraponline](https://github.com/bootstraponline)
+  [#208](https://github.com/SlatherOrg/slather/pull/208)
 
 ## v2.2.0
 

data/bin/slather

@@ -4,12 +4,14 @@ require 'yaml'
 require_relative '../lib/slather'
 require_relative '../lib/slather/command/coverage_command'
 require_relative '../lib/slather/command/setup_command'
+require_relative '../lib/slather/command/version_command'
 
 class MainCommand < Clamp::Command
   self.default_subcommand = "coverage"
 
-  subcommand "setup", "Configures a .xcodeproj for test coverage generation", SetupCommand
-  subcommand "coverage", "Computes coverage for the supplied project", CoverageCommand
+  subcommand 'setup', 'Configures a .xcodeproj for test coverage generation', SetupCommand
+  subcommand 'coverage', 'Computes coverage for the supplied project', CoverageCommand
+  subcommand 'version', 'Prints slather version', VersionCommand
 end
 
 MainCommand.run

data/lib/slather/command/coverage_command.rb

@@ -27,6 +27,7 @@ class CoverageCommand < Clamp::Command
   option ["--binary-file"], "BINARY_FILE", "The binary file against the which the coverage will be run", :multivalued => true
   option ["--binary-basename"], "BINARY_BASENAME", "Basename of the file against which the coverage will be run", :multivalued => true
   option ["--source-files"], "SOURCE_FILES", "A Dir.glob compatible pattern used to limit the lookup to specific source files. Ignored in gcov mode.", :multivalued => true
+  option ["--decimals"], "DECIMALS", "The amount of decimals to use for % coverage reporting"
 
   def execute
     puts "Slathering..."
@@ -44,6 +45,7 @@ class CoverageCommand < Clamp::Command
     setup_binary_file
     setup_binary_basename
     setup_source_files
+    setup_decimals
 
     project.configure
 
@@ -139,4 +141,8 @@ class CoverageCommand < Clamp::Command
   def setup_source_files
     project.source_files = source_files_list if !source_files_list.empty?
   end
+
+  def setup_decimals
+    project.decimals = decimals if decimals
+  end
 end

data/lib/slather/command/version_command.rb

@@ -0,0 +1,6 @@
+class VersionCommand < Clamp::Command
+
+  def execute
+    puts "slather #{Slather::VERSION}"
+  end
+end

data/lib/slather/coverage_service/html_output.rb

@@ -5,6 +5,8 @@ module Slather
   module CoverageService
     module HtmlOutput
 
+      attr_reader :docs
+
       def coverage_file_class
         if input_format == "profdata"
           Slather::ProfdataCoverageFile
@@ -79,7 +81,7 @@ module Slather
           cov.h4 {
             percentage = (total_tested_lines / total_relevant_lines.to_f) * 100.0
             cov.span "Total Coverage : "
-            cov.span '%.2f%%' % percentage, :class => class_for_coverage_percentage(percentage), :id => "total_coverage"
+            cov.span decimal_f(percentage) + '%', :class => class_for_coverage_percentage(percentage), :id => "total_coverage"
           }
 
           cov.input(:class => "search", :placeholder => "Search")
@@ -105,7 +107,7 @@ module Slather
                 cov.tr {
                   percentage = coverage_file.percentage_lines_tested
 
-                  cov.td { cov.span '%.2f' % percentage, :class => "percentage #{class_for_coverage_percentage(percentage)} data_percentage" }
+                  cov.td { cov.span decimal_f(percentage), :class => "percentage #{class_for_coverage_percentage(percentage)} data_percentage" }
                   cov.td(:class => "data_filename") {
                     cov.a filename, :href => filename_link
                   }
@@ -140,7 +142,7 @@ module Slather
         builder = Nokogiri::HTML::Builder.with(template.at('#reports')) { |cov|
           cov.h2(:class => "cov_title") {
             cov.span("Coverage for \"#{filename}\"" + (!is_file_empty ? " : " : ""))
-            cov.span("#{'%.2f' % percentage}%", :class => class_for_coverage_percentage(percentage)) unless is_file_empty
+            cov.span("#{decimal_f(percentage)}%", :class => class_for_coverage_percentage(percentage)) unless is_file_empty
           }
 
           cov.h4("(#{coverage_file.num_lines_tested} of #{coverage_file.num_lines_testable} relevant lines covered)", :class => "cov_subtitle")

data/lib/slather/coverage_service/simple_output.rb

@@ -19,7 +19,7 @@ module Slather
 
           lines_tested = coverage_file.num_lines_tested
           total_lines = coverage_file.num_lines_testable
-          percentage = '%.2f' % [coverage_file.percentage_lines_tested]
+          percentage = decimal_f([coverage_file.percentage_lines_tested])
 
           total_project_lines_tested += lines_tested
           total_project_lines += total_lines
@@ -42,7 +42,7 @@ module Slather
           puts "##teamcity[buildStatisticValue key='CodeCoverageAbsLTotal' value='%i']" % total_project_lines
         end
 
-        total_percentage = '%.2f' % [(total_project_lines_tested / total_project_lines.to_f) * 100.0]
+        total_percentage = decimal_f([(total_project_lines_tested / total_project_lines.to_f) * 100.0])
         puts "Test Coverage: #{total_percentage}%"
       end
 

data/lib/slather/project.rb

@@ -27,8 +27,8 @@ module Xcodeproj
 
       # Patch xcschemes too
       if format == :clang
-        if Gem::Requirement.new('~> 0.27') =~ Gem::Version.new(Xcodeproj::VERSION)
-          # @todo This will require to bump the xcodeproj dependency to ~> 0.27
+        if Gem::Requirement.new('>= 0.28.2') =~ Gem::Version.new(Xcodeproj::VERSION)
+          # @todo This will require to bump the xcodeproj dependency to >= 0.28.2
           # (which would require to bump cocoapods too)
           schemes_path = Xcodeproj::XCScheme.shared_data_dir(self.path)
           Xcodeproj::Project.schemes(self.path).each do |scheme_name|
@@ -51,7 +51,8 @@ module Slather
   class Project < Xcodeproj::Project
 
     attr_accessor :build_directory, :ignore_list, :ci_service, :coverage_service, :coverage_access_token, :source_directory,
-      :output_directory, :xcodeproj, :show_html, :verbose_mode, :input_format, :scheme, :workspace, :binary_file, :binary_basename, :source_files
+      :output_directory, :xcodeproj, :show_html, :verbose_mode, :input_format, :scheme, :workspace, :binary_file, :binary_basename, :source_files,
+      :decimals
 
     alias_method :setup_for_coverage, :slather_setup_for_coverage
 
@@ -106,7 +107,6 @@ module Slather
         gcov_coverage_files
       end
     end
-    private :coverage_files
 
     def gcov_coverage_files
       coverage_files = Dir["#{build_directory}/**/*.gcno"].map do |file|
@@ -238,6 +238,7 @@ module Slather
         configure_output_directory
         configure_input_format
         configure_binary_file
+        configure_decimals
       rescue => e
         puts e.message
         puts failure_help_string
@@ -295,6 +296,12 @@ module Slather
       self.scheme ||= self.class.yml["scheme"] if self.class.yml["scheme"]
     end
 
+    def configure_decimals
+      return if self.decimals
+      self.decimals ||= self.class.yml["decimals"] if self.class.yml["decimals"]
+      self.decimals = self.decimals ? Integer(self.decimals) : 2
+    end
+
     def configure_workspace
       self.workspace ||= self.class.yml["workspace"] if self.class.yml["workspace"]
     end
@@ -338,6 +345,13 @@ module Slather
       end
     end
 
+    def decimal_f decimal_arg
+      configure_decimals unless decimals
+      decimal = "%.#{decimals}f" % decimal_arg
+      return decimal if decimals == 2 # special case 2 for backwards compatibility
+      decimal.to_f.to_s
+    end
+
     def find_binary_file_in_bundle(bundle_file)
       if File.directory? bundle_file
         bundle_file_noext = File.basename(bundle_file, File.extname(bundle_file))

data/lib/slather/version.rb

@@ -1,3 +1,3 @@
 module Slather
-  VERSION = "2.2.0"
+  VERSION = '2.2.1' unless defined?(Slather::VERSION)
 end

data/slather.gemspec

@@ -23,11 +23,11 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.4"
   spec.add_development_dependency "rspec", "~> 3.4"
   spec.add_development_dependency "pry", "~> 0.9"
-  spec.add_development_dependency "cocoapods", ">= 0.39.0", "< 1.1.0"
+  spec.add_development_dependency "cocoapods", "~> 1.0"
   spec.add_development_dependency "json_spec", "~> 1.1.4"
   spec.add_development_dependency "equivalent-xml", "~> 0.5.1"
 
   spec.add_dependency "clamp", "~> 0.6"
-  spec.add_dependency "xcodeproj", ">= 0.28.2", "< 1.1.0"
+  spec.add_dependency "xcodeproj", "~> 1.1"
   spec.add_dependency "nokogiri", "~> 1.6.3"
 end

data/spec/slather/coverage_file_spec.rb

@@ -11,7 +11,7 @@ describe Slather::CoverageFile do
   end
 
   let(:coverage_file) do
-    fixtures_project.send(:coverage_files).detect { |cf| cf.source_file_pathname.basename.to_s == "fixtures.m" }
+    fixtures_project.coverage_files.detect { |cf| cf.source_file_pathname.basename.to_s == "fixtures.m" }
   end
 
   describe "#initialize" do
@@ -42,7 +42,7 @@ describe Slather::CoverageFile do
     ["cpp", "mm", "m"].each do |file_ext|
       it "should work for #{file_ext} files" do
         file_name = "fixtures_#{file_ext}.#{file_ext}"
-        coverage_file = fixtures_project.send(:coverage_files).detect { |cf| cf.source_file_pathname.basename.to_s == file_name }
+        coverage_file = fixtures_project.coverage_files.detect { |cf| cf.source_file_pathname.basename.to_s == file_name }
         expect(coverage_file.source_file_pathname).to eq(fixtures_project["fixtures/#{file_name}"].real_path)
       end
     end
@@ -124,7 +124,7 @@ OBJC
     }
 
     let(:line_coverage_file) do
-      fixtures_project.send(:coverage_files).detect { |cf| cf.source_file_pathname.basename.to_s == "fixtures.m" }
+      fixtures_project.coverage_files.detect { |cf| cf.source_file_pathname.basename.to_s == "fixtures.m" }
     end
 
     describe "#coverage_for_line" do
@@ -166,7 +166,7 @@ OBJC
   describe "branch coverage" do
 
     let(:branch_coverage_file) do
-      fixtures_project.send(:coverage_files).detect { |cf| cf.source_file_pathname.basename.to_s == "Branches.m" }
+      fixtures_project.coverage_files.detect { |cf| cf.source_file_pathname.basename.to_s == "Branches.m" }
     end
 
     describe "branch_coverage_data" do
@@ -281,7 +281,7 @@ OBJC
   describe "empty coverage data" do
 
     let(:empty_file) do
-      fixtures_project.send(:coverage_files).detect { |cf| cf.source_file_pathname.basename.to_s == "Empty.m" }
+      fixtures_project.coverage_files.detect { |cf| cf.source_file_pathname.basename.to_s == "Empty.m" }
     end
 
     describe "gcov_data" do

data/spec/slather/coverage_service/coveralls_spec.rb

@@ -34,7 +34,7 @@ describe Slather::CoverageService::Coveralls do
       it "should return valid json for coveralls coverage gcov data" do
         allow(fixtures_project).to receive(:travis_job_id).and_return("9182")
         expect(fixtures_project.send(:coveralls_coverage_data)).to be_json_eql("{\"service_job_id\":\"9182\",\"service_name\":\"travis-ci\"}").excluding("source_files")
-        expect(fixtures_project.send(:coveralls_coverage_data)).to be_json_eql(fixtures_project.send(:coverage_files).map(&:as_json).to_json).at_path("source_files")
+        expect(fixtures_project.send(:coveralls_coverage_data)).to be_json_eql(fixtures_project.coverage_files.map(&:as_json).to_json).at_path("source_files")
       end
 
       it "should raise an error if there is no TRAVIS_JOB_ID" do
@@ -50,7 +50,7 @@ describe Slather::CoverageService::Coveralls do
         allow(fixtures_project).to receive(:travis_job_id).and_return("9182")
         allow(fixtures_project).to receive(:coverage_access_token).and_return("abc123")
         expect(fixtures_project.send(:coveralls_coverage_data)).to be_json_eql("{\"service_job_id\":\"9182\",\"service_name\":\"travis-pro\",\"repo_token\":\"abc123\"}").excluding("source_files")
-        expect(fixtures_project.send(:coveralls_coverage_data)).to be_json_eql(fixtures_project.send(:coverage_files).map(&:as_json).to_json).at_path("source_files")
+        expect(fixtures_project.send(:coveralls_coverage_data)).to be_json_eql(fixtures_project.coverage_files.map(&:as_json).to_json).at_path("source_files")
       end
 
       it "should raise an error if there is no TRAVIS_JOB_ID" do
@@ -69,7 +69,7 @@ describe Slather::CoverageService::Coveralls do
         allow(fixtures_project).to receive(:circleci_build_url).and_return("https://circleci.com/gh/Bruce/Wayne/1")
         allow(fixtures_project).to receive(:circleci_git_info).and_return({ :head => { :id => "ababa123", :author_name => "bwayne", :message => "hello" }, :branch => "master" })
         expect(fixtures_project.send(:coveralls_coverage_data)).to be_json_eql("{\"service_job_id\":\"9182\",\"service_name\":\"circleci\",\"repo_token\":\"abc123\",\"service_pull_request\":\"1\",\"service_build_url\":\"https://circleci.com/gh/Bruce/Wayne/1\",\"git\":{\"head\":{\"id\":\"ababa123\",\"author_name\":\"bwayne\",\"message\":\"hello\"},\"branch\":\"master\"}}").excluding("source_files")
-        expect(fixtures_project.send(:coveralls_coverage_data)).to be_json_eql(fixtures_project.send(:coverage_files).map(&:as_json).to_json).at_path("source_files")
+        expect(fixtures_project.send(:coveralls_coverage_data)).to be_json_eql(fixtures_project.coverage_files.map(&:as_json).to_json).at_path("source_files")
       end
 
       it "should raise an error if there is no CIRCLE_BUILD_NUM" do
@@ -87,7 +87,7 @@ describe Slather::CoverageService::Coveralls do
         allow(fixtures_project).to receive(:jenkins_git_info).and_return({head: {id: "master", author_name: "author", message: "pull title" }, branch: "branch"})
         allow(fixtures_project).to receive(:jenkins_branch_name).and_return('master')
         expect(fixtures_project.send(:coveralls_coverage_data)).to be_json_eql("{\"service_job_id\":\"9182\",\"service_name\":\"jenkins\",\"repo_token\":\"abc123\",\"git\":{\"head\":{\"id\":\"master\",\"author_name\":\"author\",\"message\":\"pull title\"},\"branch\":\"branch\"}}").excluding("source_files")
-        expect(fixtures_project.send(:coveralls_coverage_data)).to be_json_eql(fixtures_project.send(:coverage_files).map(&:as_json).to_json).at_path("source_files")
+        expect(fixtures_project.send(:coveralls_coverage_data)).to be_json_eql(fixtures_project.coverage_files.map(&:as_json).to_json).at_path("source_files")
       end
 
       it "should raise an error if there is no BUILD_ID" do
@@ -156,7 +156,7 @@ describe Slather::CoverageService::Coveralls do
       it "should return valid json for coveralls coverage profdata data" do
         allow(fixtures_project).to receive(:travis_job_id).and_return("9182")
         expect(fixtures_project.send(:coveralls_coverage_data)).to be_json_eql("{\"service_job_id\":\"9182\",\"service_name\":\"travis-ci\"}").excluding("source_files")
-        expect(fixtures_project.send(:coveralls_coverage_data)).to be_json_eql(fixtures_project.send(:coverage_files).map(&:as_json).to_json).at_path("source_files")
+        expect(fixtures_project.send(:coveralls_coverage_data)).to be_json_eql(fixtures_project.coverage_files.map(&:as_json).to_json).at_path("source_files")
       end
     end
   end

data/spec/slather/coverage_service/html_output_spec.rb

@@ -26,6 +26,10 @@ describe Slather::CoverageService::HtmlOutput do
     it "should return CoverageFile" do
       expect(fixtures_project.send(:coverage_file_class)).to eq(Slather::ProfdataCoverageFile)
     end
+
+    it "should allow accessing docs via attribute" do
+      expect(fixtures_project.docs).to eq(nil)
+    end
   end
 
   describe '#post' do

data/spec/slather/project_spec.rb

@@ -53,14 +53,14 @@ describe Slather::Project do
     it "should return coverage file objects of type coverage_file_class for unignored project files" do
       fixtures_project.ignore_list = ["*fixturesTests*"]
       allow(fixtures_project).to receive(:dedupe) { |coverage_files| coverage_files }
-      coverage_files = fixtures_project.send(:coverage_files)
+      coverage_files = fixtures_project.coverage_files
       coverage_files.each { |cf| expect(cf.kind_of?(SpecCoverageFile)).to be_truthy }
       expect(coverage_files.map { |cf| cf.source_file_pathname.basename.to_s }).to eq(["fixtures.m", "peekaview.m"])
     end
 
     it "should raise an exception if no unignored project coverage file files were found" do
       fixtures_project.ignore_list = ["*fixturesTests*", "*fixtures*"]
-      expect {fixtures_project.send(:coverage_files)}.to raise_error(StandardError)
+      expect {fixtures_project.coverage_files}.to raise_error(StandardError)
     end
   end
 
@@ -503,4 +503,20 @@ describe Slather::Project do
     end
   end
 
+  def decimal_f *args
+    fixtures_project.decimal_f *args
+  end
+
+  describe '#decimal_f' do
+    it 'should preserve length 2 decimals for backwards compatibility' do
+      expect(decimal_f('100.00')).to eq('100.00')
+      expect(decimal_f('50.00')).to eq('50.00')
+    end
+
+    it 'should convert length >= 3 decimals to floats' do
+      fixtures_project.decimals = 3
+      expect(decimal_f('100.000')).to eq('100.0')
+      expect(decimal_f('50.00000')).to eq('50.0')
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,7 +1,7 @@
 if ENV['SIMPLECOV']
   require 'simplecov'
   SimpleCov.start
-else
+elsif ENV['TRAVIS']
   require 'coveralls'
   Coveralls.wear!
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slather
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.1
 platform: ruby
 authors:
 - Mark Larsen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-08 00:00:00.000000000 Z
+date: 2016-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -98,22 +98,16 @@ dependencies:
   name: cocoapods
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 0.39.0
-    - - <
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 0.39.0
-    - - <
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: json_spec
   requirement: !ruby/object:Gem::Requirement
@@ -160,22 +154,16 @@ dependencies:
   name: xcodeproj
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 0.28.2
-    - - <
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 0.28.2
-    - - <
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -216,6 +204,7 @@ files:
 - lib/slather.rb
 - lib/slather/command/coverage_command.rb
 - lib/slather/command/setup_command.rb
+- lib/slather/command/version_command.rb
 - lib/slather/coverage_file.rb
 - lib/slather/coverage_info.rb
 - lib/slather/coverage_service/cobertura_xml_output.rb