onceover-codequality 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0fd0fa7b9afbcebd806a148ee5f9550f7d0fb240
-  data.tar.gz: 1751c2747cd62a34dc3e49f253eaa2ac14e49929
+SHA256:
+  metadata.gz: 05b4b045d5c1f2c0629b1491cbb69b297e0cf81febbc48e9ea0f0a3257f94ca5
+  data.tar.gz: d185ea9bdb68f25b039c0fa075029af670e74b53269d44618b14bdca75e60b54
 SHA512:
-  metadata.gz: 829ea5f9e914b9a4527c975ec9db4832f60c91eb8c6f7ccc9afd7a73de46032c40afc7f40599bc6fd35712c7f95415e4dabb9659c65ea786c270d1784f7ba95f
-  data.tar.gz: 39cec48a3ff533236403f183badcaccedae5c6c20ad6229685177d998607291e4daca7c7d893ea2b9b66fe4036337485fb121058176d597bcb26c34d30e5aa5d
+  metadata.gz: ffca9f5955db6be466d3d62400c07123bf00c07f05685263abd3f269604f872ab83907a22dac60f87a0c24f12ccfb6ff9571d83d7b60f2e5295a095b1c891390
+  data.tar.gz: d282f5b85bb63312bd89747f3c1c64a317830405b368c3faf44057f18c137d01ba3c7bbce444db34dc56051942eb160e239d71b784f6f7ad284a5ee145ed2d5c

data/README.md

@@ -39,12 +39,18 @@ $ onceover run codequality
 $onceover run codequality --no_lint
 ```
 
-**Skip syntax check**
+**Skip Puppet syntax check**
 
 ```shell
 $ onceover run codequality --no_syntax
 ```
 
+**Skip Puppetfile syntax check**
+
+```shell
+$ onceover run codequality --no_puppetfile
+```
+
 **Skip documentation generation**
 
 ```shell
@@ -114,15 +120,7 @@ $ bundle exec onceover run codequality
 * [puppet-lint](https://github.com/rodjek/puppet-lint)
 * [puppet-syntax](https://github.com/voxpupuli/puppet-syntax)
 * [puppet-strings](https://github.com/puppetlabs/puppet-strings/) 
-
-
-**My docs change a ton of files every time I run?**
-This is because the timestamp is embedded inside the generated docs by default.  This is fixed in the master branch of Puppet Strings which has not been released as a gem yet.  You can reference the fixed version in your control repository Gemfile, like this:
-
-```ruby
-gem 'puppet-strings',
-  :git => 'https://github.com/puppetlabs/puppet-strings'
-``` 
+* [r10k](https://github.com/puppetlabs/r10k/)
 
 ## Development
 

data/lib/onceover/codequality/cli.rb

@@ -1,6 +1,7 @@
 require "onceover/codequality/lint"
 require "onceover/codequality/syntax"
 require "onceover/codequality/docs"
+require "onceover/codequality/puppetfile"
 class Onceover
   module CodeQuality
     class CLI
@@ -8,20 +9,24 @@ class Onceover
         def self.command
           @cmd ||= Cri::Command.define do
             name 'codequality'
-            usage 'codequality [--no-syntax] [--no-lint] [--no-docs]'
+            usage 'codequality [--no-syntax] [--no-lint] [--no-docs] [--html-docs] [--no-puppetfile]'
             summary "Code Quality checking for onceover"
             description <<-DESCRIPTION
-Check files in your Control Repository for Lint and Syntax errors
+              Check files in your Control Repository for Lint and Syntax errors
             DESCRIPTION
           
-            option :l, :no_lint, 'Do not check for lint errors', :argument => :optional
-            option :x, :no_syntax, 'Do not check for syntax errors', :argument => :optional
-            option :d, :no_docs, 'Do not generate documentation (puppet-strings) for local modules', :argument => :optional
+            option :no_lint, 'Do not check for lint errors', :argument => :optional
+            option :no_puppetfile, 'Do not check Puppetfile for syntax errors', :argument => :optional
+            option :no_syntax, 'Do not check for syntax errors', :argument => :optional
+            option :no_docs, 'Do not generate documentation (puppet-strings) for local modules', :argument => :optional
+            option :html_docs, 'Generate docs in HTML format instead of markdown', :argument => :optional
 
             run do |opts, args, cmd|
               no_lint = opts[:no_lint] || false
               no_syntax = opts[:no_syntax] || false
               no_docs = opts[:no_docs] || false
+              no_puppetfile = opts[:no_puppetfile] || false
+              html_docs = opts[:html_docs] || false
               status = true
               if ! no_lint
                 logger.info "Checking for lint..."
@@ -31,6 +36,14 @@ Check files in your Control Repository for Lint and Syntax errors
                 end
               end
 
+              if ! no_puppetfile
+                logger.info "Checking Puppetfile"
+                if ! Onceover::CodeQuality::Puppetfile.puppetfile
+                  status = false
+                  logger.error "puppetfile syntax failed, see previous errors"
+                end
+              end
+
               if ! no_syntax
                 logger.info "Checking syntax..."
                 if ! Onceover::CodeQuality::Syntax.puppet
@@ -41,7 +54,7 @@ Check files in your Control Repository for Lint and Syntax errors
 
               if ! no_docs
                 logger.info "Generating documentation..."
-                if ! Onceover::CodeQuality::Docs.puppet_strings
+                if ! Onceover::CodeQuality::Docs.puppet_strings(html_docs)
                   status = false
                   logger.error "Documentation generation failed, see previous errors"
                 end

data/lib/onceover/codequality/docs.rb

@@ -5,12 +5,13 @@ class Onceover
     module Docs
       LOCAL_MOD_DIR = "site"
 
-      def self.puppet_strings
+      def self.puppet_strings(html_docs)
         status = true
+        format = html_docs ? "html" : "markdown"
         if Dir.exist?(LOCAL_MOD_DIR)
           Dir.glob("#{LOCAL_MOD_DIR}/*/") { |dir|
             Dir.chdir(dir) {
-              status &= system("puppet strings")
+              status &= system("puppet strings generate --format #{format}")
             }
           }
         end

data/lib/onceover/codequality/puppetfile.rb

@@ -0,0 +1,21 @@
+# Support for checking syntax of Puppetfile
+class Onceover
+  module CodeQuality
+    module Puppetfile
+
+      def self.puppetfile
+        if File.exists? "Puppetfile"
+          status = system("bundle exec r10k puppetfile check")
+        else
+          puts "No Puppetfile found!"
+          status = false
+        end
+
+        status
+      end
+
+    end
+  end
+end
+
+

data/lib/onceover/codequality/version.rb

@@ -1,5 +1,5 @@
 class Onceover
   module CodeQuality
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

data/onceover-codequality.gemspec

@@ -27,5 +27,5 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'onceover', '~> 3'
   spec.add_runtime_dependency 'puppet-syntax', '~> 2'
   spec.add_runtime_dependency 'puppet-lint', '~> 2'
-  spec.add_runtime_dependency 'puppet-strings', '~> 1'
+  spec.add_runtime_dependency 'puppet-strings', '~> 2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: onceover-codequality
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Declarative Systems
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-22 00:00:00.000000000 Z
+date: 2018-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '2'
 description: 
 email:
 - sales@declarativesystems.com
@@ -128,6 +128,7 @@ files:
 - lib/onceover/codequality/cli.rb
 - lib/onceover/codequality/docs.rb
 - lib/onceover/codequality/lint.rb
+- lib/onceover/codequality/puppetfile.rb
 - lib/onceover/codequality/syntax.rb
 - lib/onceover/codequality/version.rb
 - onceover-codequality.gemspec
@@ -151,7 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Lint and syntax validation for onceover