puppet-community-rangefinder 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d27fe23607e34a37dc211d6526ea57f99ebf25f212af104e94c837c40a7bd8a
-  data.tar.gz: c03245d149ba06bce93c0ccfc8a969a81aa20366cb85b2e3e96c7df01b6e3b9f
+  metadata.gz: a5fb940183c9ea99d93b015d05a74475499e9053a720d4e376712b39523fc76e
+  data.tar.gz: 9d609345c22b46ef5018ea80d9bf02e70ff2ce774c2e20d00eca5b62183614b7
 SHA512:
-  metadata.gz: 4050af14e897cc9d52d87fbac5850ca651c0283c2c5e5452e798e18d161d27076db089b0b787da6b8cae254470823906bbb2d2044417b992dfc197e1e09d9b0f
-  data.tar.gz: 6813a1cacb4bcb438c04c45c00f7113b5560be29749da273b90f8eb2b0dde7a6bc0d239fdfc54539610acc3592df562341bc4e52a68e0f774d2b8def4585170b
+  metadata.gz: fa4c71d46436dd4d7b5032a0da5c2948f687e8c783eb2d701c7aba6a7abdd6dd7e2ce02e7656989bc267fef0c780c73f31c54ae4b379217f6f4acfe7ef2fba52
+  data.tar.gz: cfd912d3b589d22c2533aac92c6f32b410ed2eef460b43f8a8fe802834fba8cde6a4888cdb5386a3de3e7df82c9bdd6bc736ff8c5c73ec70c3c699ca6fcd93ac

data/CHANGELOG.md

@@ -1,7 +1,13 @@
+# v0.0.5
+
+* Ported to use the public dataset by default now.
+
+
 # v0.0.4
 
 * Render stats for Puppetfile dependencies
 
+
 # v0.0.3
 
 * Added summary view for a list of files

data/README.md

@@ -31,28 +31,6 @@ This currently knows how to interpret and look up:
 
 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.
-
-Example configuration:
-
-```
----
-:gcloud:
-  :dataset: <dataset>
-  :project: <project>
-  :keyfile: ~/.rangefinder/credentials.json
-```
-
-Contact [me](mailto:ben.ford@puppet.com) for credentials.
-
 
 ## Running
 
@@ -397,14 +375,35 @@ Breaking changes to this file MAY impact these modules:
 ```
 
 
+## Configuration
+
+Rangefinder will use the public dataset by default. If you're developing on the
+data pipeline, you may configure BigQuery credentials in the `~/.rangefinder.conf`
+file to point at private datasets instead.
+
+Example configuration:
+
+```
+---
+:gcloud:
+  :dataset: <dataset>
+  :project: <project>
+  :keyfile: ~/.rangefinder/credentials.json
+```
+
+Contact [me](mailto:ben.ford@puppet.com) for credentials.
+
+
 ## Limitations
 
 This is super early in development and has not yet been battle tested.
 
+
 ## Disclaimer
 
 I take no liability for the use of this tool.
 
+
 Contact
 -------
 

data/bin/rangefinder

@@ -6,7 +6,17 @@ require 'optparse'
 require 'rangefinder'
 
 loglevel = Logger::WARN
-options  = YAML.load_file(File.expand_path('~/.rangefinder.conf')) rescue {}
+options = {
+  :gcloud => {
+    :noinit  => true,
+    :dataset => 'community',
+    :project => 'dataops-puppet-public-data',
+    :keyfile => File.join(File.dirname(__FILE__), '..', 'assets', 'read-only-credentials.json')
+  }
+}
+overrides = YAML.load_file(File.expand_path('~/.rangefinder.conf')) rescue {}
+options.merge!(overrides)
+
 OptionParser.new do |opts|
   opts.banner = "Usage: rangefinder <paths>
 
@@ -46,8 +56,9 @@ Note that non-namespaced items will always be near match only.
   end
 
 end.parse!
+options[:gcloud][:keyfile] = File.expand_path(options[:gcloud][:keyfile])
 options[:filenames]   = ARGV.map {|f| File.expand_path f} unless ARGV.empty?
-options[:filenames] ||= ['manifests/init.pp']
+options[:filenames] ||= ['manifests']
 options[:render]    ||= :human
 
 $logger           = Logger.new($stderr)

data/lib/rangefinder.rb

@@ -12,7 +12,7 @@ class Rangefinder
     @bigquery = Rangefinder::Bigquery.new(options)
 
     if options[:filenames].size == 1 and File.directory?(options[:filenames].first)
-      options[:filenames] = Dir.glob("#{options[:filenames].first}/*")
+      options[:filenames] = Dir.glob("#{options[:filenames].first}/**/*")
     end
   end
 

data/lib/rangefinder/bigquery.rb

@@ -7,7 +7,6 @@ class Rangefinder::Bigquery
 
     raise "Required gCloud configuration missing" unless gcloud
 
-    gcloud[:keyfile] = File.expand_path(gcloud[:keyfile])
     @bigquery = Google::Cloud::Bigquery.new(
       :project_id  => gcloud[:project],
       :credentials => Google::Cloud::Bigquery::Credentials.new(gcloud[:keyfile]),
@@ -18,8 +17,8 @@ class Rangefinder::Bigquery
 
   def find(namespace, kind, name)
     sql = "SELECT DISTINCT module, i.source, m.source AS repo
-           FROM `bto-dataops-datalake-prod.community.forge_itemized` AS i
-           JOIN `bto-dataops-datalake-prod.community.forge_modules` AS m
+           FROM `#{@dataset.project_id}.#{@dataset.dataset_id}.forge_itemized` AS i
+           JOIN `#{@dataset.project_id}.#{@dataset.dataset_id}.forge_modules` AS m
              ON m.slug = i.module
            WHERE kind = @kind AND element = @name"
 
@@ -45,14 +44,14 @@ class Rangefinder::Bigquery
 
   def puppetfile_count(modname=nil)
     if modname
-      sql = 'SELECT COUNT(DISTINCT repo_name) AS count
-             FROM `bto-dataops-datalake-prod.community.github_puppetfile_usage`
-             WHERE module = @name'
+      sql = "SELECT COUNT(DISTINCT repo_name) AS count
+             FROM `#{@dataset.project_id}.#{@dataset.dataset_id}.github_puppetfile_usage`
+             WHERE module = @name"
 
       data = @dataset.query(sql, params: {name: modname})
     else
-      sql = 'SELECT COUNT(DISTINCT repo_name) AS count
-             FROM `bto-dataops-datalake-prod.community.github_puppetfile_usage`'
+      sql = "SELECT COUNT(DISTINCT repo_name) AS count
+             FROM `#{@dataset.project_id}.#{@dataset.dataset_id}.github_puppetfile_usage`"
 
       data = @dataset.query(sql)
     end

data/lib/rangefinder/version.rb

@@ -1,3 +1,3 @@
 class Rangefinder
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-community-rangefinder
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Ben Ford
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-18 00:00:00.000000000 Z
+date: 2020-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet
@@ -48,11 +48,6 @@ description: |2
     Run this command with a space separated list of file paths in a module and it
     will infer what each file defines and then tell you what Forge modules use it.
 
-    ******************************************************************************
-    * Note that this is only useful by members of the Puppet Ecosystem team      *
-    * because it uses BigQuery data that's not available publicly.               *
-    ******************************************************************************
-
     Run `rangefinder --help` to get started.
 email: ben.ford@puppet.com
 executables:
@@ -89,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Predicts downstream impact of breaking file changes.