onceover-codequality 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 435eb54d0970e1cd68cf84062cc809ee021ece0d
-  data.tar.gz: '03583b96994f073a2a53b7e6061e4db2f66c7906'
+  metadata.gz: 0fd0fa7b9afbcebd806a148ee5f9550f7d0fb240
+  data.tar.gz: 1751c2747cd62a34dc3e49f253eaa2ac14e49929
 SHA512:
-  metadata.gz: 525c36a6417ec005cf9b8839fae16053a3748945da12c9ad140819a6017732eb91f654edd4d6ecbfd73f8a59b66dcc5bf019c292077576dc425c67f045c46bef
-  data.tar.gz: f7f713f7ef1bba783fd54067bf057258dde2264fa069003fed16e681fbc81e9a626549f96bb999f8fb5bc13d705b7cbb843a571c63516da1a5c17a79a97de707
+  metadata.gz: 829ea5f9e914b9a4527c975ec9db4832f60c91eb8c6f7ccc9afd7a73de46032c40afc7f40599bc6fd35712c7f95415e4dabb9659c65ea786c270d1784f7ba95f
+  data.tar.gz: 39cec48a3ff533236403f183badcaccedae5c6c20ad6229685177d998607291e4daca7c7d893ea2b9b66fe4036337485fb121058176d597bcb26c34d30e5aa5d

data/README.md

@@ -8,6 +8,8 @@ The plugin checks your control repository for:
 * Linting
 * Syntax
 
+And then generates documentation using [Puppet Strings](https://github.com/puppetlabs/puppet-strings/)
+
 For sure you can hack around with rake/make and hack something up each time but aint nobody got time for that!
 
 ## Installation
@@ -43,6 +45,13 @@ $onceover run codequality --no_lint
 $ onceover run codequality --no_syntax
 ```
 
+**Skip documentation generation**
+
+```shell
+$ onceover run codequality --no_doc
+```
+
+
 ## Sample output
 
 **All clear**
@@ -103,7 +112,17 @@ $ bundle exec onceover run codequality
 **What are you using under-the-hood?**
 
 * [puppet-lint](https://github.com/rodjek/puppet-lint)
-* [puppet-syntax](https://github.com/voxpupuli/puppet-syntax) 
+* [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'
+``` 
 
 ## Development
 

data/lib/onceover/codequality/cli.rb

@@ -1,5 +1,6 @@
 require "onceover/codequality/lint"
 require "onceover/codequality/syntax"
+require "onceover/codequality/docs"
 class Onceover
   module CodeQuality
     class CLI
@@ -7,7 +8,7 @@ class Onceover
         def self.command
           @cmd ||= Cri::Command.define do
             name 'codequality'
-            usage 'codequality [--no-lint] [--no-syntax]'
+            usage 'codequality [--no-syntax] [--no-lint] [--no-docs]'
             summary "Code Quality checking for onceover"
             description <<-DESCRIPTION
 Check files in your Control Repository for Lint and Syntax errors
@@ -15,10 +16,12 @@ Check files in your Control Repository for Lint and Syntax errors
           
             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
 
             run do |opts, args, cmd|
               no_lint = opts[:no_lint] || false
               no_syntax = opts[:no_syntax] || false
+              no_docs = opts[:no_docs] || false
               status = true
               if ! no_lint
                 logger.info "Checking for lint..."
@@ -36,6 +39,14 @@ Check files in your Control Repository for Lint and Syntax errors
                 end
               end
 
+              if ! no_docs
+                logger.info "Generating documentation..."
+                if ! Onceover::CodeQuality::Docs.puppet_strings
+                  status = false
+                  logger.error "Documentation generation failed, see previous errors"
+                end
+              end
+
               if status
                 logger.info "Code Quality tests passed, have a nice day"
               else

data/lib/onceover/codequality/docs.rb

@@ -0,0 +1,23 @@
+# Support for generating documentation using Puppet Strings for each module
+# listed in the site directory
+class Onceover
+  module CodeQuality
+    module Docs
+      LOCAL_MOD_DIR = "site"
+
+      def self.puppet_strings
+        status = true
+        if Dir.exist?(LOCAL_MOD_DIR)
+          Dir.glob("#{LOCAL_MOD_DIR}/*/") { |dir|
+            Dir.chdir(dir) {
+              status &= system("puppet strings")
+            }
+          }
+        end
+
+        status
+      end
+
+    end
+  end
+end

data/lib/onceover/codequality/syntax.rb

@@ -4,9 +4,16 @@ class Onceover
   module CodeQuality
     module Syntax
       def self.puppet
+        status = true
+        if File.exist?("Puppetfile")
+          status &= system("r10k puppetfile check")
+        else
+          logger.warn("No Puppetfile found... continuing")
+        end
+
         # rake task contains an exit statement so run it in a subshell to
         # capture and continue
-        status = system(
+        status &= system(
 "ruby << EOD
     require 'puppet-syntax/tasks/puppet-syntax'
     Rake::Task['syntax'].invoke

data/lib/onceover/codequality/version.rb

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

data/onceover-codequality.gemspec

@@ -27,4 +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'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: onceover-codequality
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Declarative Systems
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-12 00:00:00.000000000 Z
+date: 2017-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
+- !ruby/object:Gem::Dependency
+  name: puppet-strings
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
 description: 
 email:
 - sales@declarativesystems.com
@@ -112,6 +126,7 @@ files:
 - bin/setup
 - lib/onceover/codequality.rb
 - lib/onceover/codequality/cli.rb
+- lib/onceover/codequality/docs.rb
 - lib/onceover/codequality/lint.rb
 - lib/onceover/codequality/syntax.rb
 - lib/onceover/codequality/version.rb