pp-stats 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dddf9d6b5f0caa035bd417aa54e39c9d45232858
+  data.tar.gz: a133a637ffd03fdf8539bd97247915d45c549cf3
+SHA512:
+  metadata.gz: a4ec883a92a3ce7c9bd07440f7df79986743d966b9496dd97f74cc08dba5627a44a264d5326e19e4385da862c593d709fe3ed34c410c4de9c29271f7ecddf6ec
+  data.tar.gz: 52fe50d0099e6551e0820256052e3a75e301ef7f16c90616b8849ee3b1f0b6c75a4575359285fd2292598417e8ef010337336f3b1fde6eefa899b11927b0ffd8

data/.gitignore

@@ -0,0 +1,54 @@
+#################
+## IntelliJ
+#################
+
+.classpath
+.project
+.settings/
+.idea/
+*.iml
+*.iws
+
+#################
+## Eclipse
+#################
+
+*.pydevproject
+.project
+.metadata
+#bin/
+tmp/
+*.tmp
+*.bak
+*.swp
+*~.nib
+local.properties
+.classpath
+.settings/
+.loadpath
+
+# External tool builders
+.externalToolBuilders/
+
+# Locally stored "Eclipse launch configurations"
+*.launch
+
+# CDT-specific
+.cproject
+
+# PDT-specific
+.buildpath
+
+############
+## Windows
+############
+
+# Windows image file caches
+Thumbs.db
+
+# Folder config file
+Desktop.ini
+
+*.gem
+.bundle
+Gemfile.lock

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright © 2014 Jason Thigpen
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,27 @@
+# pp-stats
+
+Command line ruby program that generates stats for Puppet module(s).
+
+## Install
+
+Get it from rubygems
+
+```
+$ gem install pp-stats
+```
+
+## Usage
+
+With no arguments, `pp-stats` assumes you're in a directory full of Puppet modules. Alternatively, provide a path to a directory of Puppet modules.
+
+```
+$ pp-stats ~/workspace/corp/puppet
+```
+
+![](PuppetSummary.png)
+
+## Credit
+
+This tool was originally developed by Adam Denning ([adenning](https://github.com/adenning/pp-stats)).
+
+When I found it, the repo only had a single commit almost one year old. It provided a very good starting point, so I have forked it and added some bits for my own needs. I have kept Adam's initial commit for posterity and I have added an [MIT License](LICENSE.txt) for good measure.

data/bin/pp-stats

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'pp-stats'
+PPStats::CommandLine.new(ARGV).run

data/lib/pp-stats.rb

@@ -0,0 +1,11 @@
+require 'pp-stats/format'
+require 'pp-stats/utils'
+require 'pp-stats/counter'
+require 'pp-stats/summary'
+require 'pp-stats/modules'
+require 'pp-stats/processor'
+require 'pp-stats/command-line'
+
+module PPStats
+
+end

data/lib/pp-stats/command-line.rb

@@ -0,0 +1,50 @@
+require 'optparse'
+
+module PPStats
+  class CommandLine
+
+    def initialize(args)
+    end
+
+    def run
+      options = {}
+      optparse = OptionParser.new do |opts|
+        opts.banner = "usage: pp-stats [options] modulepath"
+        opts.on('--single-module', 'process a single module') do |flag|
+          options[:single_module] = flag
+        end
+      end
+
+      # Enforce required options and more graceful error handling.
+      begin
+        optparse.parse!
+        # Not using required options anymore but I left it wired up.
+        required = []
+        missing = required.select { |param| options[param].nil? }
+        if not missing.empty?
+          PPStats::Format.errorf("missing options: #{missing.join(', ')}")
+          exit
+        end
+      rescue OptionParser::InvalidOption, OptionParser::MissingArgument
+        PPStats::Format.errorf($!.to_s) # $! is exception object
+        exit
+      end
+
+      if ARGV.first.nil?
+        options[:modulepath] = '.'
+      else
+        options[:modulepath] = ARGV.first
+      end
+      if !File.directory? options[:modulepath]
+        PPStats::Format.errorf "module folder '#{options[:modulepath]}' not found"
+        exit
+      end
+
+      processor = PPStats::Processor.new(options)
+      processor.run
+      processor.results
+    end
+
+
+  end
+end

data/lib/pp-stats/counter.rb

@@ -0,0 +1,41 @@
+module PPStats
+  class Counter
+    attr_reader :count
+
+    def initialize
+      @count = {
+          :files                  => 0,
+          :lines                  => 0,
+          :max_lines              => 0,
+          :max_file               => nil,
+          :floor_lines            => nil,
+          :floor_file             => nil,
+          :commented_lines        => 0,
+          :max_commented_lines    => 0,
+          :max_commented_file     => '',
+          :floor_commented_lines  => 0,
+          :floor_commented_file   => nil,
+      }
+    end
+
+    def adjust(file, lines, commented_lines)
+      @count[:files] += 1
+      @count[:lines] += lines
+      if lines > @count[:max_lines]
+        @count[:max_lines] += lines
+        @count[:max_file] = file
+      end
+      @count[:commented_lines] += commented_lines
+      if commented_lines > @count[:max_commented_lines]
+        @count[:max_commented_lines] = commented_lines
+        @count[:max_commented_file] = file
+      end
+      if commented_lines < @count[:floor_commented_lines] || @count[:floor_commented_lines] == 0
+        @count[:floor_commented_lines] = commented_lines
+        @count[:floor_commented_file] = file
+      end
+
+    end
+
+  end
+end

data/lib/pp-stats/format.rb

@@ -0,0 +1,68 @@
+module PPStats
+  module Format
+    def self.warnf(msg)
+      warn("Warning: #{msg}".yellow)
+    end
+
+    def self.errorf(msg)
+      warn("Error: #{msg}".red)
+    end
+
+    def self.green(msg)
+      msg.green
+    end
+
+    def self.blue(msg)
+      msg.blue
+    end
+
+    def self.magenta(msg)
+      msg.magenta
+    end
+
+    def self.cyan(msg)
+      msg.cyan
+    end
+
+    def self.gray(msg)
+      msg.gray
+    end
+
+  end
+end
+
+class String
+  require 'Win32/Console/ANSI' if RbConfig::CONFIG['host_os'] =~ /mswin|win32|dos|mingw|cygwin/i
+
+  def colorize(color_code)
+    "\e[#{color_code}m#{self}\e[0m"
+  end
+
+  def red
+    colorize(31)
+  end
+
+  def green
+    colorize(32)
+  end
+
+  def yellow
+    colorize(33)
+  end
+
+  def blue
+    colorize(34)
+  end
+
+  def magenta
+    colorize(35)
+  end
+
+  def cyan
+    colorize(36)
+  end
+
+  def gray
+    colorize(37)
+  end
+end

data/lib/pp-stats/modules.rb

@@ -0,0 +1,128 @@
+require 'pathname'
+
+module PPStats
+  class Modules
+
+    attr_reader :types, :module_count, :classes, :defines
+
+    def initialize(options)
+      @options = options
+      @types = ModuleTypes.instance.types
+      @procssed_file = false
+      @previous_line = nil
+      @module_count = 0
+      @classes = 0
+      @defines = 0
+    end
+
+    def run
+      if @options[:single_module]
+        process_module(@options[:modulepath])
+      else
+        PPStats::Utils.files_dotless(@options[:modulepath]).each do |file|
+          file = File.join(@options[:modulepath], file)
+          process_module file if File.directory? file
+        end
+      end
+
+    end
+
+    def results
+      summary = PPStats::Summary.new(@types, @module_count, @classes, @defines)
+      summary.run
+    end
+
+    def process_module(moddir)
+      puts PPStats::Format.green "module #{moddir}"
+      @types.each do |k,v|
+        puts PPStats::Format.blue "  #{k.to_s}"
+        process_type(moddir, v)
+        puts if @procssed_file
+      end
+      @module_count += 1
+    end
+
+    def process_type(moddir, type)
+      @procssed_file = false
+      return if !File.directory? moddir
+
+      type.dirs.each do |dir|
+        files = PPStats::Utils.files_recursive_nodirs(File.join(moddir, dir))
+        files.each_with_index do |file, index|
+          if filter_file(file, type)
+            count, commented_count = process_file(file, index+1, files.length)
+            type.counter.adjust(file, count, commented_count)
+          end
+        end
+      end
+    end
+
+    def filter_file(file, type)
+      ext = File.extname(file)
+      if type.file_exts == '*'
+        if ext =~ /\.\d/
+          return false
+        elsif type.exclude_exts.include? ext
+          return false
+        else
+          return true
+        end
+      end
+      type.file_exts.include? ext
+    end
+
+    def process_file(path, index, totfiles)
+      @procssed_file = true
+      file = Pathname.new(path).basename
+      line = "\r    #{file} (#{index}/#{totfiles})"
+      STDOUT.write "\r" + " "*@previous_line.length if !@previous_line.nil?
+      @previous_line = line
+      STDOUT.write line
+      STDOUT.flush
+      lines = File.new(path).readlines
+      commented_lines = lines.select { |line| line =~ /^#/ }
+      c = lines.select { |line| line =~ /^class/ }
+      d = lines.select { |line| line =~ /^define/ }
+      sleep(0.05)
+      @classes += 1 if ! c.empty?
+      @defines += 1 if ! d.empty?
+      return lines.count, commented_lines.count
+    end
+
+    class ModuleTypes
+      require 'singleton'
+      include Singleton
+
+      attr_reader :types
+
+      def initialize
+        @types = {
+            :manifests   => ModuleType.new(['manifests'], ['.pp']),
+            :templates   => ModuleType.new(['templates'], ['.erb']),
+            :libraries   => ModuleType.new(['lib'], ['.rb']),
+            :unit_tests  => ModuleType.new(['spec/classes',
+                                          'spec/defines',
+                                          'spec/functions',
+                                          'spec/host',
+                                          'spec/unit'],
+                                         ['.rb']),
+            :system_tests => ModuleType.new(['spec/system'], ['.rb']),
+            #:file => ModuleType.new('files', '*')
+        }
+      end
+
+    end
+
+    class ModuleType
+      attr_reader :dirs, :file_exts, :counter, :exclude_exts
+
+      def initialize(dirs, file_exts='*')
+        @dirs = dirs
+        @file_exts = file_exts
+        @counter = PPStats::Counter.new
+        @exclude_exts = ['', '.png', '.exe', '.a']
+      end
+    end
+
+  end
+end

data/lib/pp-stats/processor.rb

@@ -0,0 +1,17 @@
+module PPStats
+  class Processor
+    def initialize(options)
+      @options = options
+      @modules = PPStats::Modules.new(@options)
+    end
+
+    def run
+      @modules.run
+    end
+
+    def results
+      @modules.results
+    end
+
+  end
+end

data/lib/pp-stats/summary.rb

@@ -0,0 +1,33 @@
+module PPStats
+  class Summary
+    def initialize(types, module_count, classes, defines)
+      @types = types
+      @module_count = module_count
+      @classes = classes
+      @defines = defines
+    end
+
+    def run
+      puts PPStats::Format.cyan "-"*35
+      @types.each do |k,v|
+        puts PPStats::Format.cyan k.to_s
+        print_summary_line('files', v.counter.count[:files])
+        print_summary_line('lines', v.counter.count[:lines])
+        print_summary_line('max lines', "#{v.counter.count[:max_lines]} - #{v.counter.count[:max_file]}")
+        print_summary_line('commented lines', v.counter.count[:commented_lines])
+        print_summary_line('most commented', "#{v.counter.count[:max_commented_lines]} - #{v.counter.count[:max_commented_file]}")
+        print_summary_line('least commented', "#{v.counter.count[:floor_commented_lines]} - #{v.counter.count[:floor_commented_file]}")
+      end
+      puts PPStats::Format.cyan "-"*35
+      puts PPStats::Format.cyan "Totals"
+      print_summary_line('modules', "#{@module_count}")
+      print_summary_line('classes', "#{@classes}")
+      print_summary_line('defines', "#{@defines}")
+    end
+
+    def print_summary_line(label, data)
+      printf "  %-20s #{data}\n", label
+    end
+
+  end
+end

data/lib/pp-stats/utils.rb

@@ -0,0 +1,11 @@
+module PPStats
+  module Utils
+    def self.files_dotless(path)
+      Dir.new(path).entries.reject { |f|  f =~ /^\./}
+    end
+
+    def self.files_recursive_nodirs(path)
+      Dir.glob("#{path}/**/*").entries.reject { |f| File.directory? f }
+    end
+  end
+end

data/pp-stats.gemspec

@@ -0,0 +1,16 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name          = 'pp-stats'
+  s.version       = '0.0.3'
+  s.date          = '2013-01-13'
+  s.summary       = "Puppet Stats"
+  s.description   = "Command line ruby program that generates stats for Puppet module(s)"
+  s.authors       = ["Jason Thigpen"]
+  s.email         = "darwin@sent.us"
+  s.files         = `git ls-files`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.homepage      = 'https://github.com/cdarwin/pp-stats'
+  s.license       = 'MIT'
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: pp-stats
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Jason Thigpen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-13 00:00:00.000000000 Z
+dependencies: []
+description: Command line ruby program that generates stats for Puppet module(s)
+email: darwin@sent.us
+executables:
+- pp-stats
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE.txt
+- PuppetSummary.png
+- README.md
+- bin/pp-stats
+- lib/pp-stats.rb
+- lib/pp-stats/command-line.rb
+- lib/pp-stats/counter.rb
+- lib/pp-stats/format.rb
+- lib/pp-stats/modules.rb
+- lib/pp-stats/processor.rb
+- lib/pp-stats/summary.rb
+- lib/pp-stats/utils.rb
+- pp-stats.gemspec
+homepage: https://github.com/cdarwin/pp-stats
+licenses:
+- MIT
+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.2.1
+signing_key: 
+specification_version: 4
+summary: Puppet Stats
+test_files: []