updates

Author: binford2k

Gemfile

@@ -1,7 +1,3 @@
 source 'https://gem.coop'
 
-gem 'rake'
-gem 'puppetfile-resolver'
-gem 'puppet_forge'
-gem 'pry'
-
+gemspec

README.md

@@ -1,2 +1,14 @@
-# puppetfile-source-dereference
-Replaces forge references with the git source in a Puppetfile
+# Puppetfile Source Dereference
+
+This is a simple tool to replace forge references with the git source in a Puppetfile.
+The intent is to reduce your dependency on the Puppet Forge in cases of service interruptions.
+
+The simplest use case is to simply run the tool in the root directory of a Puppet module.
+It will generate a `Puppetfile.out`, which you will need to inspect and clean up.
+
+Comments and formatting will not be preserved, you'll need to reconcile that.
+
+> ⚠️ There is not a standard mapping of Forge release versions to git ref (branch, tag, etc).
+> This tool will take a very simplistic guess at the ref, but many modules will be wrong.
+> You'll need to use your human brain and look at the module repo and decide which ref to use.
+

lib/puppetfile-source-dereference.rb

@@ -3,6 +3,7 @@
 require "puppetfile-resolver/puppetfile/parser/r10k_eval"
 require 'puppet_forge'
 require 'yaml'
+require 'open-uri'
 
 class PuppetfileSourceDereference
   attr_accessor :source, :output, :dryrun, :mapping
@@ -17,7 +18,7 @@ def initialize(options = {})
 
   def resolve
     puppetfile = PuppetfileResolver::Puppetfile::Parser::R10KEval.parse(File.read(@source))
-    mapping    = YAML.load(open(@mapping).read)
+    mapping    = YAML.load(URI.open(@mapping).read)
 
     unless puppetfile.valid?
       logger.error("Puppetfile source is not valid")
@@ -40,7 +41,7 @@ def resolve
             output.write <<~EOF
               mod '#{mod.title}',
                 :git => '#{source}',
-                :ref => '#{mod.version.delete_prefix('=')}'
+                :ref => '#{mod.version.delete_prefix('=')}'  # check the source repo and fix this ref
             EOF
           else
             output.write <<~EOF
@@ -49,7 +50,7 @@ def resolve
             EOF
           end
         else
-          output.write "mod '#{mod.title}', #{version}\n"
+          output.write "mod '#{mod.title}', #{version}  # unmapped entry!\n"
         end
       end
     end

puppetfile-source-dereference.gemspec

@@ -0,0 +1,25 @@
+$:.unshift File.expand_path("../lib", __FILE__)
+require 'date'
+require 'puppetfile-source-dereference/version'
+
+Gem::Specification.new do |s|
+  s.name              = "puppetfile-source-dereference"
+  s.version           = PuppetfileSourceDereference::VERSION
+  s.date              = Date.today.to_s
+  s.summary           = "Replaces forge references in a Puppetfile with the git source."
+  s.homepage          = "https://github.com/overlookinfra/puppetfile-source-dereference/"
+  s.email             = "[email protected]"
+  s.authors           = ["Ben Ford"]
+  s.license           = "GPL-3.0"
+  s.require_path      = "lib"
+  s.executables       = %w( puppetfile-source-dereference )
+  s.files             = %w( README.md LICENSE )
+  s.files            += Dir.glob("lib/**/*")
+  s.files            += Dir.glob("bin/**/*")
+  s.add_dependency      'puppetfile-resolver', '~> 0.5.0'
+
+  s.description       = <<-desc
+    This will replace all Forge entries in a Puppetfile with git sources if the
+    pubished module has `source` defined.
+  desc
+end