onceover-metrics 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '019dd3e865c6d0e8d4f75bbe7484dc1d863a8556a4a2e01e4da44df62d0c99a0'
+  data.tar.gz: 17767640afff186ea49deb5a0a337c8e43518f2287e1b5da9bab3b1bd69a3a20
+SHA512:
+  metadata.gz: 1acfab7b85ee4f1afcf9bbd9f80fafe44848e15fe307bdcda29a92bb2c71578b95b9f368eec87f7677f9753e42b73b19d6f4db1a9091cc9b877878c0a5791d84
+  data.tar.gz: b0bbc8058d9ca0cfcd320838734f4790aade725a65bb7e10c70acdc41ac878d17cb87014c2ebc8dafdea189bf7eba47682f65e37b15794a65a06e45cbedbb65e

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+.idea

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in onceover-metrics.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,136 @@
+PATH
+  remote: .
+  specs:
+    onceover-metrics (0.1.0)
+      onceover (~> 3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    backticks (1.0.2)
+    blockenspiel (0.5.0)
+    colored (1.2)
+    cri (2.15.3)
+      colored (~> 1.2)
+    deep_merge (1.2.1)
+    diff-lcs (1.3)
+    facter (2.5.1)
+    faraday (0.13.1)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.12.2)
+      faraday (>= 0.7.4, < 1.0)
+    fast_gettext (1.1.2)
+    gettext (3.2.9)
+      locale (>= 2.0.5)
+      text (>= 1.3.0)
+    gettext-setup (0.30)
+      fast_gettext (~> 1.1.0)
+      gettext (>= 3.0.2)
+      locale
+    git (1.5.0)
+    hiera (3.5.0)
+    hocon (1.2.5)
+    httpclient (2.8.3)
+    json (2.2.0)
+    little-plugger (1.1.4)
+    locale (2.1.2)
+    log4r (1.1.10)
+    logging (2.2.2)
+      little-plugger (~> 1.1)
+      multi_json (~> 1.10)
+    metaclass (0.0.4)
+    minitar (0.8)
+    mocha (1.8.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.13.1)
+    multipart-post (2.0.0)
+    onceover (3.12.1)
+      backticks (>= 1.0.2)
+      colored (~> 1.2)
+      cri (>= 2.6)
+      deep_merge (>= 1.0.0)
+      git
+      json (>= 1.8.2)
+      logging (>= 2.0.0)
+      parallel_tests (>= 2.0.0)
+      puppet (>= 3.4.0)
+      puppetlabs_spec_helper (>= 0.4.0)
+      r10k (>= 2.1.0)
+      rake (>= 10.0.0)
+      rspec (>= 3.0.0)
+      rspec-puppet (>= 2.4.0)
+      rspec_junit_formatter (>= 0.2.0)
+      table_print (>= 1.0.0)
+      versionomy (>= 0.5.0)
+    parallel (1.14.0)
+    parallel_tests (2.28.0)
+      parallel
+    pathspec (0.2.1)
+    puppet (6.3.0)
+      facter (> 2.0.1, < 4)
+      fast_gettext (~> 1.1.2)
+      hiera (>= 3.2.1, < 4)
+      httpclient (~> 2.8)
+      locale (~> 2.1)
+      multi_json (~> 1.10)
+      puppet-resource_api (~> 1.5)
+      semantic_puppet (~> 1.0)
+    puppet-lint (2.3.6)
+    puppet-resource_api (1.8.1)
+      hocon (>= 1.0)
+    puppet-syntax (2.4.3)
+      rake
+    puppet_forge (2.2.9)
+      faraday (>= 0.9.0, < 0.14.0)
+      faraday_middleware (>= 0.9.0, < 0.13.0)
+      gettext-setup (~> 0.11)
+      minitar
+      semantic_puppet (~> 1.0)
+    puppetlabs_spec_helper (2.13.1)
+      mocha (~> 1.0)
+      pathspec (~> 0.2.1)
+      puppet-lint (~> 2.0)
+      puppet-syntax (~> 2.0)
+      rspec-puppet (~> 2.0)
+    r10k (3.1.1)
+      colored (= 1.2)
+      cri (~> 2.15.1)
+      gettext-setup (~> 0.24)
+      log4r (= 1.1.10)
+      multi_json (~> 1.10)
+      puppet_forge (~> 2.2.8)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-puppet (2.7.3)
+      rspec
+    rspec-support (3.8.0)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    semantic_puppet (1.0.2)
+    table_print (1.5.6)
+    text (1.3.1)
+    versionomy (0.5.0)
+      blockenspiel (~> 0.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.15)
+  onceover-metrics!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.6

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,50 @@
+# Onceover::Metrics
+
+This is an example plugin for [Onceover](https://github.com/dylanratcliffe/onceover), _The gateway drug to automated infrastructure testing with Puppet_
+
+## Installation
+
+Onceover detects plugins in all gems named `onceover-*`.  Your plugin is then responsible for registering itself and setting up new commands, etc.
+
+This example plugin can be installed by adding it to your `Gemfile` or by running the following command:
+
+```shell
+$ gem install onceover-metrics
+```
+
+## Usage
+Onceover provides plugins with built-in support for help and argument processing.  Here's how to run this example:
+
+**Built-in help**
+
+```shell
+$ onceover run metrics --help
+```
+
+**Default execution**
+
+```shell
+$ onceover run metrics
+```
+
+**Option processing**
+
+```shell
+$ onceover run metrics --name Wednesday
+INFO   -> Hello, Wednesday!
+```
+
+## Integration highlights
+* [Onceover compatibility definition](https://github.com/declarativesystems/onceover-metrics/blob/master/onceover-metrics.gemspec#L27)
+* [Library self-registration](https://github.com/declarativesystems/onceover-metrics/blob/master/lib/onceover/metrics.rb#L2)
+* [Command definition](https://github.com/declarativesystems/onceover-metrics/blob/master/lib/onceover/metrics/cli.rb#L9)
+* [Command self-registration](https://github.com/declarativesystems/onceover-metrics/blob/master/lib/onceover/metrics/cli.rb#L34)
+
+
+## Development
+
+Finished (for now) - hopefully this makes writing your own plugins for Onceover easier :)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/declarativesystems/onceover-metrics.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "onceover/metrics"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/onceover/metrics.rb

@@ -0,0 +1,9 @@
+require "onceover/metrics/version"
+require "onceover/metrics/cli"
+
+class Onceover
+  module Metrics
+  end
+end
+
+

data/lib/onceover/metrics/cli.rb

@@ -0,0 +1,33 @@
+# Create a class to hold the new command definition.  The class defined should
+# match the file we are contained in.
+require 'onceover/metrics/metrics'
+class Onceover
+  module Metrics
+    class CLI
+
+        # Static method defining the new command to be added
+        def self.command
+          @cmd ||= Cri::Command.define do
+            name 'metrics'
+            usage 'metrics [--format NAME]'
+            summary "Metrics plugin for Onceover"
+            description <<-DESCRIPTION
+Output some handy code metrics so you can guage the size of your Puppet code
+            DESCRIPTION
+
+            option nil, :format, 'Format - json, csv or text', :argument => :optional, default: "text"
+            flag nil, :detailed, 'Output per-class stats in text mode', :argument => :optional, default: false
+
+            run do |opts, args, cmd|
+              Onceover::Metrics::Metrics.run opts
+            end
+          end
+        end
+      end
+  end
+end
+
+# Register the new command with onceover.  The method you add must match your 
+# own code
+Onceover::CLI::Run.command.add_command(Onceover::Metrics::CLI.command)
+

data/lib/onceover/metrics/metrics.rb

@@ -0,0 +1,278 @@
+require 'yaml'
+require 'csv'
+require 'deep_merge'
+
+class Onceover
+  module Metrics
+    module Metrics
+      PUPPETFILE            = "Puppetfile"
+      ENVIRONMENT_CONF      = "environment.conf"
+      TOTALS_KEY            = :totals
+      PUPPETFILE_KEY        = :puppetfile
+      SITE_MODULES_KEY      = :site_modules
+      HIERA_KEY             = :hiera
+      YAML_KEY              = :yaml
+      FILES_KEY             = :files
+      TEMPLATES_KEY         = :templates
+      LINES_KEY             = :lines
+      COMMENTS_KEY          = :comments
+      MANIFESTS_KEY         = :manifests
+      LIBS_KEY              = :libs
+      MODULES_KEY           = :modules
+      CODE_KEY              = :code
+      HIERA_FILES_KEY       = :hiera_yaml_files
+      HIERA_KEYS_UNIQUE     = :hiera_keys_unique
+      HIERA_TOP_LEVEL_KEYS  = :top_level_keys
+
+
+      def self.puppetfile
+        data = File.readlines(PUPPETFILE)
+        mod_count = data.grep(/^\s*mod /).size
+
+        # inline definition barfs on keyname in variable
+        stats = {}
+        stats = {
+          TOTALS_KEY => {
+            MODULES_KEY => mod_count,
+          }
+        }
+
+        stats
+      end
+
+      def self.modpath_dirs
+        dirs = []
+        modulepath_line = File.readlines(ENVIRONMENT_CONF).grep(/^\s*modulepath\s*=/)
+        modulepath_value = modulepath_line[0].split(/=/)[1]
+        modulepath_value.split(":").reject { |e|
+          ! (e =~ /\w+/)
+        }.each { |e| 
+          dirs << e.strip
+        }
+
+        dirs
+      end
+
+      def self.code_stats
+        # per module+file stats
+        stats = {
+          # agregate stats
+          TOTALS_KEY => {
+            LINES_KEY => 0,
+            COMMENTS_KEY => 0,
+            CODE_KEY => 0,
+            MANIFESTS_KEY => 0,
+            TEMPLATES_KEY => 0,
+            FILES_KEY => 0,
+            LIBS_KEY => 0,
+            MODULES_KEY => 0,
+          },
+
+          # per module scan path stats
+          CODE_KEY => {
+            SITE_MODULES_KEY => {},
+          },
+        }
+
+        # each scan path
+        modpath_dirs.each { |modpath_dir|
+          # ..but a scan path element may not exist...
+          if Dir.exist? modpath_dir
+            stats[CODE_KEY][SITE_MODULES_KEY][modpath_dir] = {}
+
+            Dir.entries(modpath_dir).select { |mod_dir|
+              File.directory? File.join(modpath_dir, mod_dir) and !(mod_dir =='.' || mod_dir == '..')
+            }.each do |mod_dir|
+              # each module dir
+              stats[CODE_KEY][SITE_MODULES_KEY][modpath_dir][mod_dir] = {
+                MANIFESTS_KEY => {},
+              }
+
+
+              Dir.chdir "#{modpath_dir}/#{mod_dir}" do
+                # each puppet module
+
+                Dir.chdir "manifests" do
+                  # each puppet manifest
+                  Dir["**/*.pp"].each { |pp_file|
+                    data                 = File.readlines(pp_file)
+                    lines                = data.size
+                    comments             = data.grep(/^\s*#/).size
+                    code                 = lines - comments
+                    stats[CODE_KEY][SITE_MODULES_KEY][modpath_dir][mod_dir][MANIFESTS_KEY][pp_file] = {
+                      LINES_KEY => lines,
+                      COMMENTS_KEY => comments,
+                      CODE_KEY => code,
+                    }
+
+                    # update the global total counts
+                    stats[TOTALS_KEY][LINES_KEY] += lines
+                    stats[TOTALS_KEY][COMMENTS_KEY] += comments
+                    stats[TOTALS_KEY][CODE_KEY] += code
+                    stats[TOTALS_KEY][MANIFESTS_KEY] += 1
+                  }
+                end
+
+                stats[CODE_KEY][SITE_MODULES_KEY][modpath_dir][mod_dir][TOTALS_KEY] = {
+                  TEMPLATES_KEY => (Dir["templates/**/*"].count { |file| File.file?(file)}),
+                  LIBS_KEY => (Dir["lib/**/*"].count { |file| File.file?(file)}),
+                  FILES_KEY => (Dir["files/**/*"].count { |file| File.file?(file)}),
+                }
+
+                stats[TOTALS_KEY][TEMPLATES_KEY] += stats[CODE_KEY][SITE_MODULES_KEY][modpath_dir][mod_dir][TOTALS_KEY][TEMPLATES_KEY]
+                stats[TOTALS_KEY][LIBS_KEY] += stats[CODE_KEY][SITE_MODULES_KEY][modpath_dir][mod_dir][TOTALS_KEY][LIBS_KEY]
+                stats[TOTALS_KEY][FILES_KEY] += stats[CODE_KEY][SITE_MODULES_KEY][modpath_dir][mod_dir][TOTALS_KEY][FILES_KEY]
+                stats[TOTALS_KEY][MODULES_KEY] += 1
+              end
+            end
+          end
+        }
+
+        stats
+  
+      end
+
+      # assumes hiera data in /data
+      def self.hiera
+        stats = {
+          HIERA_KEY => {},
+          TOTALS_KEY => {},
+          HIERA_KEY => {
+            YAML_KEY => {},
+          },
+        }
+        total_lines = 0
+        yaml_files = Dir["data/**/*.yaml"]
+
+        # parse each file to count top-level keys
+        top_level_keys = []
+        yaml_files.each do |yaml_file|
+
+          # count lines that are whitespace or comments
+          lines = File.readlines(yaml_file).reject{|e| e =~ /^\s*(\s*|#.*)$/}.length
+
+          data = YAML.load_file(yaml_file)
+          stats[HIERA_KEY][YAML_KEY][yaml_file] = {
+            LINES_KEY => lines,
+          }
+
+          total_lines += lines
+          if data
+            # there may be files with no keys...
+            stats[HIERA_KEY][YAML_KEY][yaml_file][HIERA_TOP_LEVEL_KEYS] = data.keys.length
+            top_level_keys << data.keys
+          end
+
+        end
+
+        stats[TOTALS_KEY] = {
+          HIERA_FILES_KEY   => yaml_files.length,
+          HIERA_KEYS_UNIQUE => top_level_keys.uniq.length,
+          LINES_KEY         => total_lines,
+        }
+
+        stats
+      end
+
+
+      def self.print_table(h, indent="")
+        col_width = 50 - indent.length
+        h.each do |k,v|
+          kf = k.to_s.gsub(/_/, ' ')
+          printf("#{indent}%-#{col_width}s %10s\n", kf, v)
+        end
+      end
+
+      def self.format_report(stats, detailed)
+        if detailed
+          puts "----- [Hiera] -----"
+          stats[HIERA_KEY][YAML_KEY].each do |yaml_file, data|
+            puts yaml_file
+            print_table(data, "  ")
+          end
+          puts ""
+        end
+
+        puts "----- [Puppet Code] -----"
+        stats[CODE_KEY][SITE_MODULES_KEY].each do |modpath, modpath_data|
+          # each path element
+          puts "#{modpath}"
+
+          modpath_data.each do | mod_name, mod_data |
+            # each module
+            indent = "  "
+            puts "#{indent}#{mod_name}"
+
+            indent = "    "
+            # per-module metrics
+            print_table(mod_data[TOTALS_KEY], indent)
+
+            # per-manifest stats
+            print_table({MANIFESTS_KEY => mod_data[MANIFESTS_KEY].length}, indent)
+
+            if detailed
+              mod_data[MANIFESTS_KEY].each { |pp_file, stats|
+
+                indent = "      "
+                puts "#{indent}#{pp_file}"
+
+                indent = "        "
+                print_table(stats, indent)
+              }
+            end
+          end
+        end
+        puts ""
+
+        puts "***** [TOTALS] *****"
+        stats[TOTALS_KEY].each do |k,v|
+          puts k
+          print_table(v, "  ")
+        end
+
+
+      end
+
+      def self.run(opts)
+        puppetfile = puppetfile()
+        code_stats = code_stats()
+        hiera = hiera()
+
+        stats = {
+          CODE_KEY => code_stats[CODE_KEY],
+          HIERA_KEY => hiera[HIERA_KEY],
+          TOTALS_KEY => {
+            PUPPETFILE_KEY => puppetfile[TOTALS_KEY],
+            CODE_KEY => code_stats[TOTALS_KEY],
+            HIERA_KEY => hiera[TOTALS_KEY],
+            TOTALS_KEY => {
+              LINES_KEY => code_stats[TOTALS_KEY][LINES_KEY] + hiera[TOTALS_KEY][LINES_KEY],
+              MODULES_KEY => puppetfile[TOTALS_KEY][MODULES_KEY] + code_stats[TOTALS_KEY][MODULES_KEY]
+            }
+          },
+        }
+
+        if opts[:format] == "json"
+          pretty_json = JSON.pretty_generate(stats)
+          puts pretty_json
+        elsif opts[:format] == "csv"
+
+          csv_string = CSV.generate do |csv|
+            stats[TOTALS_KEY].each { |k,v|
+              csv << [k]
+              v.to_a.each {|elem| csv << elem}
+              csv << []
+            }
+          end
+
+          puts csv_string
+        else
+          # human mode
+          format_report(stats, opts[:detailed])
+        end
+
+      end
+    end
+  end
+end
+

data/lib/onceover/metrics/version.rb

@@ -0,0 +1,5 @@
+class Onceover
+  module Metrics
+    VERSION = "0.1.0"
+  end
+end

data/onceover-metrics.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "onceover/metrics/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "onceover-metrics"
+  spec.version       = Onceover::Metrics::VERSION
+  spec.authors       = ["Declarative Systems"]
+  spec.email         = ["sales@declarativesystems.com"]
+  spec.license       = "Apache-2.0"
+
+  spec.summary       = %q{Example plugin for onceover}
+  spec.homepage      = "https://github.com/declarativesystems/onceover-metrics"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_runtime_dependency 'onceover', '~> 3'
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: onceover-metrics
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Declarative Systems
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: onceover
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: 
+email:
+- sales@declarativesystems.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/onceover/metrics.rb
+- lib/onceover/metrics/cli.rb
+- lib/onceover/metrics/metrics.rb
+- lib/onceover/metrics/version.rb
+- onceover-metrics.gemspec
+homepage: https://github.com/declarativesystems/onceover-metrics
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Example plugin for onceover
+test_files: []