onceover-codequality 0.6.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee41694d81a21ab44a8d2c7b6630740ac8caa219d64e2bbcf14fadf1f9d919af
-  data.tar.gz: a3a16cc00241852ee07f0cf162cdd2fb10187c9218912ef814f3f13dcd6ce44d
+  metadata.gz: 74c3c08709d8f2e00c4a2df14806c6a8c87d510543aa23aaa95351df5c27fdaf
+  data.tar.gz: b2b2c9023c49a39365be2266c7c74d43e53d35fc13a492153d8720cda54132ed
 SHA512:
-  metadata.gz: 6f63484487dc3d9211652a827648879b1d8c9dc76e7720b959dff30e17357061bd249cc5eb1fc5a22ac3fe714809e36bdd2cff65f72e4ddf2ac6dedcb6b1ea78
-  data.tar.gz: 75e20bdd744457c8783c903f290cc4238d83f3d44479db02146f00f666daacab8041cb7d0abead69df1b468ed0e441b488cb0863a48f89d5b2e3e021b8757f65
+  metadata.gz: f03f53e1f1a475f1e7f93fdb17cf06b979661c684a092ea805d75fa07e32ce31794293c5a6a866c352175f729c0e4ebebf218a198107c36d24ff9f26423c4416
+  data.tar.gz: dbf6f562d7de09b0134d41330a5db2a0d6a306c0c9b6b92e1d8ffe262e85a44259379111787a35ef58087982bcc1e8ab0d6b492e15ea53aeea9b953a28b94001

data/.gitignore

@@ -1,7 +1,7 @@
 /.bundle/
 **/.yardoc
 **/REFERENCE.md
-/spec/fixtures/**/doc
+/spec/testcase/**/doc
 /_yardoc/
 /coverage/
 /doc/

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    onceover-codequality (0.6.0)
+    onceover-codequality (0.7.0)
       onceover (~> 3)
       puppet-lint (~> 2)
       puppet-strings (~> 2)

data/lib/onceover/codequality/cli.rb

@@ -2,6 +2,7 @@ require "onceover/codequality/lint"
 require "onceover/codequality/syntax"
 require "onceover/codequality/docs"
 require "onceover/codequality/puppetfile"
+require "onceover/codequality/environment"
 require "onceover/codequality/executor"
 require "onceover/codequality/formatter"
 class Onceover

data/lib/onceover/codequality/docs.rb

@@ -1,24 +1,26 @@
 # Support for generating documentation using Puppet Strings for each module
-# listed in the site directory
+# listed in the environment.conf modulepath
 class Onceover
   module CodeQuality
     module Docs
-      LOCAL_MOD_DIR = "site"
 
       def self.puppet_strings(html_docs)
         status = true
         format = html_docs ? "--markup html" : "--format markdown"
-        if Dir.exist?(LOCAL_MOD_DIR)
-          Dir.glob("#{LOCAL_MOD_DIR}/*/") { |dir|
-            Dir.chdir(dir) {
-              CodeQuality::Formatter.start_test("Generate documentation in #{dir}")
-              # puppet strings prints useful metrics so don't swallow its output
-              output, ok = CodeQuality::Executor.run("puppet strings generate #{format}")
-              status &= ok
-              CodeQuality::Formatter.end_test(output, ok, true)
+
+        CodeQuality::Environment.get_site_dirs.each { |local_mod_dir|
+          if Dir.exist?(local_mod_dir)
+            Dir.glob("#{local_mod_dir}/*/") { |dir|
+              Dir.chdir(dir) {
+                CodeQuality::Formatter.start_test("Generate documentation in #{dir}")
+                # puppet strings prints useful metrics so don't swallow its output
+                output, ok = CodeQuality::Executor.run("puppet strings generate #{format}")
+                status &= ok
+                CodeQuality::Formatter.end_test(output, ok, true)
+              }
             }
-          }
-        end
+          end
+        }
 
         status
       end

data/lib/onceover/codequality/environment.rb

@@ -0,0 +1,34 @@
+class Onceover
+  module CodeQuality
+    module Environment
+
+      ENVIRONMENT_CONF = "environment.conf"
+
+      # Latest best practice is to change the name of `site` to be
+      # `site-modules`. This means we need to start processing `environment.conf`
+      # to extract this...
+      def self.get_site_dirs()
+        if File.exist?(ENVIRONMENT_CONF)
+          #modulepath = site-modules:modules:$basemodulepath
+          modulepath = open(ENVIRONMENT_CONF) { |f| f.each_line.find { |line| line.include?("modulepath") } }
+
+          begin
+            environments = modulepath.split("=")[1].split(":").reject { |e|
+              # reject any elements containing interpolation or referencing modules
+              # loaded by r10k
+              e =~ /\$/ || e == "modules" || e =~ /[\\.\/]/
+            }.map {
+              |e| e.strip
+            }
+          rescue NoMethodError => e
+            raise "Malformed environment configuration: #{ENVIRONMENT_CONF}"
+          end
+        else
+          raise "Missing environment configuration: #{ENVIRONMENT_CONF}"
+        end
+
+        environments
+      end
+    end
+  end
+end

data/lib/onceover/codequality/lint.rb

@@ -26,11 +26,12 @@ class Onceover
 
         # wait until runtime to scan directories for unit tests
         lint_paths = LINT_PATHS.concat(
-          Dir.glob('site/*')
-          .select { |f| File.directory? f}
+          CodeQuality::Environment.get_site_dirs.each { |site_dir|
+            Dir.glob("#{site_dir}/*").select { |f| File.directory? f}
+          }
         )
         lint_paths.each { |p|
-          if Dir.exists?(p)
+          if Dir.exist?(p)
             CodeQuality::Formatter.start_test("lint in #{p}")
             output, ok = CodeQuality::Executor.run("puppet-lint #{LINT_OPTIONS.join ' '} #{p}")
             status &= ok

data/lib/onceover/codequality/version.rb

@@ -1,5 +1,5 @@
 class Onceover
   module CodeQuality
-    VERSION = "0.6.0"
+    VERSION = "0.7.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: onceover-codequality
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Declarative Systems
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-18 00:00:00.000000000 Z
+date: 2019-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -128,6 +128,7 @@ files:
 - lib/onceover/codequality.rb
 - lib/onceover/codequality/cli.rb
 - lib/onceover/codequality/docs.rb
+- lib/onceover/codequality/environment.rb
 - lib/onceover/codequality/executor.rb
 - lib/onceover/codequality/formatter.rb
 - lib/onceover/codequality/lint.rb