puppet-community-rangefinder 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ca220be6aa4a132ea5446370c2be2e02fa5d4d391026eea586e24636f6010c8
-  data.tar.gz: 3aa913744e8abc0a9425ebe22e3dea4a32c957e1382df8eedda2c4241d055bbb
+  metadata.gz: df586be47d07b0f0933e86a199d3ba2bfe7ab07ea4cdca70a16ebe0c1373c3da
+  data.tar.gz: 752482ad501454c4e2d0634ed56eef876e2ee8f4fc6a700a9e8fa3a630c47b2b
 SHA512:
-  metadata.gz: 865fc5f2c07268fb2dcb18e23b1ac56eb9b700008fde3cdadf663470c9410a4fc85faa61242adb9c46b1c19c6c2977390216b18140636694070b8158f6d07ed2
-  data.tar.gz: d65542c4505d25adee4058818240870cdce74a0dd1a2ef04bb5178cf673a476a6f2870a07c68cd3afc834ce4b051cb3ec3f0de00976b4d8166b7fd5a4b5ea61c
+  metadata.gz: 489cbbd291d5d246c4e293e8ab8477466351382646bfd982236c6f479c137b4698c55e58ea2dffd0321868471fd35e335806d48421e119ce5ec4c6b9044509b8
+  data.tar.gz: 98e847461177dc4b1c753867cfc9d7d9ea52dee6c6963f97c0ec3fcb4741886a1ada3d8ecef94e9d2496f53d215c34b758b7c17845d1e241647d7693ae2d6f52

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# v0.0.3
+
+* Added summary view for a list of files
+* Changed how the output was generated to enable library usage
+
+
 # v0.0.2
 
 * better identification of WILL impact and MAY impact lists

data/README.md

@@ -26,7 +26,17 @@ This currently knows how to interpret and look up:
 * Defined types
 * Puppet resource types
 
-   
+
+## Installation
+
+This is distributed as a Ruby gem. Simply `gem install puppet-community-rangefinder`
+
+    ******************************************************************************
+    * Note that this is only useful by members of the Puppet Ecosystem team      *
+    * because it uses BigQuery data that's not available publicly.               *
+    ******************************************************************************
+
+
 ## Configuration
 
 You must configure BigQuery credentials in the `~/.rangefinder.conf` file.

data/bin/rangefinder

@@ -16,13 +16,15 @@ will infer what each file defines and then tell you what Forge modules use it.
 It will separate output by the modules that we KNOW will be impacted and those
 which we can only GUESS that will be impacted. We can tell the difference based
 on whether the impacted module has properly described dependencies in their
-`metadata.json`.
+`metadata.json`. These are rendered as *exact match* and *near match*.
+
+Note that non-namespaced items will always be near match only.
 
 "
 
-  opts.on('-r', '--render-as FORMAT', 'Render the output as human, json, or yaml') do |val|
+  opts.on('-r', '--render-as FORMAT', 'Render the output as human, summarize, json, or yaml') do |val|
     val = val.downcase.to_sym
-    fail "Unknown output type (#{val})" unless [:human, :json, :yaml].include? val
+    fail "Unknown output type (#{val})" unless [:human, :summarize, :json, :yaml].include? val
     options[:render] = val
   end
 

data/lib/rangefinder/version.rb

@@ -1,3 +1,3 @@
 class Rangefinder
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/lib/rangefinder.rb

@@ -6,16 +6,45 @@ class Rangefinder
   require 'rangefinder/version'
 
   def initialize(options)
+    options[:filenames] ||= [] # don't blow up if we're called with no files
+
     @options  = options
     @bigquery = Rangefinder::Bigquery.new(options)
 
     if options[:filenames].size == 1 and File.directory?(options[:filenames].first)
       options[:filenames] = Dir.glob("#{options[:filenames].first}/*")
     end
+
+    @maxlen = options[:filenames].map {|f| File.basename(f).length }.max
   end
 
   def render!
-    @options[:filenames].each do |filename|
+    results = analyze(@options[:filenames])
+
+    if @options[:render] == :summarize
+      printf("%-#{@maxlen}s%12s%8s%6s\n", 'Item Name', 'Kind', 'Exact', 'Near')
+      puts '=' * (@maxlen+26)
+    end
+
+    results.compact.each do |item|
+      case @options[:render]
+      when :human
+        puts pretty_print(item)
+      when :summarize
+        puts print_line(item)
+      when :json
+        puts JSON.pretty_generate(item)
+      when :yaml
+        require 'yaml'
+        puts item.to_yaml
+      else
+        raise "Invalid render type (#{@options[:render]})."
+      end
+    end
+  end
+
+  def analyze(files)
+    files.map do |filename|
       case File.extname(filename).downcase
       when '.pp'
         kind, name = Rangefinder::Parser::Puppet.new(filename).evaluate!
@@ -31,19 +60,7 @@ class Rangefinder
         next
       end
 
-      results = @bigquery.find(namespace(filename), kind, name)
-
-      case @options[:render]
-      when :human
-        puts pretty_print(results)
-      when :json
-        puts JSON.pretty_generate(results)
-      when :yaml
-        require 'yaml'
-        puts results.to_yaml
-      else
-        raise "Invalid render type (#{@options[:render]})."
-      end
+      @bigquery.find(namespace(filename), kind, name)
     end
   end
 
@@ -62,6 +79,10 @@ class Rangefinder
     metadata['name']
   end
 
+  def print_line(results)
+    sprintf("%-#{@maxlen}s%12s%8d%6d\n", results[:name], results[:kind], results[:exact].size, results[:near].size)
+  end
+
   def pretty_print(results)
     output  = "[#{results[:name]}] is a _#{results[:kind]}_\n"
     output << "==================================\n"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-community-rangefinder
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Ben Ford
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-01 00:00:00.000000000 Z
+date: 2018-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet