packaging_rake_tasks 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a6c2f335bedf85cca66fadb1412b1573c61b2a8
-  data.tar.gz: ec31791f04fbc8811acf023de7b21faae6857049
+  metadata.gz: 07be7d847721fb9cd00e02a81a61181036ea3c95
+  data.tar.gz: 40d1a420ffdc26ce7a72c66de362365684247428
 SHA512:
-  metadata.gz: 088613d225ff99c913058e471931fa0daab456f3c3916d8e0d92dfad33dc44c64143718fe16f65ccaaa20a581c3353a4e1d5fa87cded244a0440622685bebe7b
-  data.tar.gz: c5d0825bb4fb74382b68dffa8ca25d0860de8c15fcb55fca0eb23c7a72c7654798c322281724092695017505104bab7c5e7393e4299e71ee2de25d6d75416f6b
+  metadata.gz: 4236b2291ea9d9a345650354b97647e132842d9c114e1eb71392111aa89f8e3b3dde0fda6f1fe20978fe0ce51989f86a87266ffbcbebcec54f63134bc13f0d3b
+  data.tar.gz: 427112492ed7493be6d74be0a4f7aad8c9fc666ac6f584955f134ee1ee6ebad8279883bb117b9062308eadb2cf3ed62fb4cac6b9650d132f821a87d1231bebf6

data/VERSION

@@ -1 +1 @@
-1.2.1
+1.3.0

data/lib/packaging/configuration.rb

@@ -30,6 +30,7 @@ module Packaging
       @obs_target = "openSUSE_Factory"
       @skip_license_check = []
       @maintenance_mode = false
+      @documentation_minimal = 0
     end
 
     #custom package name, by default directory name
@@ -58,6 +59,9 @@ module Packaging
     attr_accessor :skip_license_check
     # Specify if project is in maintenance mode. If so, then it create maintenance request instead of pull request
     attr_accessor :maintenance_mode
+    # Minimal documentation coverage to pass check:doc
+    # Default value is 0.
+    attr_accessor :documentation_minimal
 
     def package_name
       @package_name ||= Dir.pwd.split("/").last

data/lib/tasks/check_doc.rake

@@ -0,0 +1,66 @@
+# Copyright (C) 2017 SUSE LLC
+#   This library is free software; you can redistribute it and/or modify
+# it only under the terms of version 2.1 of the GNU Lesser General Public
+# License as published by the Free Software Foundation.
+#
+#   This library is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
+# details.
+#
+#   You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, contact SUSE LLC.
+#
+# To contact SUSE LLC about this file by physical or electronic mail, you may
+# find current contact information at www.suse.com.
+
+require "packaging/configuration"
+
+def check_doc_output
+  ENV["LANG"] = "C"
+  puts "Generating documentation..." if verbose
+  result = `yardoc`
+  if $?.exitstatus != 0
+    raise "yardoc failed"
+  end
+
+  puts result if verbose
+
+  lines = result.lines
+
+  warn_lines = lines.grep(/\[warn\]:/)
+  if !warn_lines.empty?
+    raise "There are #{warn_lines.size} warning/-s in yardoc output"
+  end
+
+  coverage_line = lines.grep(/% documented/).first
+  if !coverage_line
+    raise "Sorry, output format of yardoc changed. Please report issue for packaging rake tasks "\
+      " and include output of your yardoc and its version"
+  end
+
+  coverage = coverage_line[/(\d+\.?\d*)% documented/, 1].to_f
+  if coverage < Packaging::Configuration.instance.documentation_minimal
+    raise "Too low documentation coverage #{coverage}%."
+  end
+end
+
+def check_doc
+  if !File.exist?(".yardopts")
+    puts ".yardopts not found, skipping documentation check"
+    return
+  end
+
+  if !system("which", "yardoc")
+    raise "yardoc not found"
+  end
+
+  check_doc_output
+end
+
+namespace "check" do
+  desc "Check for errors in documentation and minimal coverage (supported: rubydoc)"
+  task :doc do
+    check_doc
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: packaging_rake_tasks
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Josef Reidinger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-01 00:00:00.000000000 Z
+date: 2017-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -38,6 +38,7 @@ files:
 - lib/packaging/tasks.rb
 - lib/tasks/check_changelog.rake
 - lib/tasks/check_committed.rake
+- lib/tasks/check_doc.rake
 - lib/tasks/check_license.rake
 - lib/tasks/check_osc.rake
 - lib/tasks/check_syntax.rake
@@ -64,10 +65,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.2
 signing_key: 
 specification_version: 4
 summary: Rake tasks providing tasks to package project in git and integration with
   build service
 test_files: []
-has_rdoc: