generate-puppetfile 0.9.3 → 0.9.4

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NDRjNTE2ZWYzNGU0MDNhNWYxYmYzYTg3MWI2NTc1YTJkNzlkM2U5Yg==
+    MGRhMmMzNmZhZDdiNzQ3ZTIyOThjMDY4OTEwYmQ1N2M3ODhmNzUwNA==
   data.tar.gz: !binary |-
-    Y2JkNjk3MWUyOTU4NDRjYzIwNTM4YWQ2YzU2YTA1ZjI1ZGNlYTkwNQ==
+    NjUzMDg5M2UzMDc1ZDQxNzU0M2Q2MDRlN2VlODI0NmYwOTA2YmRjNw==
 SHA512:
   metadata.gz: !binary |-
-    MmUxMTMwYjRmODdhZjk5OTE2Y2YwOTY2MTYwNjY4OTYyZTEzNjcwZDAwYTBh
-    MmI0YmIyMjA4ZGE5NzM4NmFiNmFkMzI4ZDYyZWFjYzU3NDQ0OGQ4NDQ1MDM2
-    NmZlYzAwMDg5NWM4MWZmY2U4NjJmYjg4ODlkM2NkMTcyNGFiNzE=
+    ZGE2MDk0N2VmYzA4ZjFiNzJmZTk5N2M3OTRhZDg4Yjg5MDU5NjA1MWNmNjcz
+    YWMzMGIzM2RkMTFkODI0YzE5MzgwZTUxZTYwYmE2ZjNiZGIzNWZjNzg2YTY0
+    NDI1ODAzM2U4YTZlOTIzMWFhYWMyNzY5ZDMwYjFjYTRmOWVmYjc=
   data.tar.gz: !binary |-
-    MjdmN2YzYWJkOTY3MzY1NmQ5ZmYzNzFlNDg2YjMwM2ExNzBkYWFiODc3NTdh
-    MDdkMmUzZTViNDYzMjNkOGNhMTlhM2FjZjNiYjJlYjk3NWVkODY1NzY5YzVj
-    NGUzZWY2MzUxYTk5NmI3M2MxZjM0YjkyYWU3Nzk0YWFhNmEzYTM=
+    NzljNTgzYzhjYmY3MDAxNzMxNjRmMWE0ZjM1ZmRhZWNhNTZmYTliMWVhNTRi
+    ZTEwZjYxZjIwNjM0ZTA4NGJjMDYzYTkwNzk4NGYyNTFiOWI1MjYxMjRlNjYw
+    N2U4YWIzOThhYjQ3NGE1MjRiOGU0N2JhMWZhYjM5NGM4NWIyZTY=

data/lib/generate_puppetfile/bin.rb

@@ -8,7 +8,9 @@ module GeneratePuppetfile
   # Internal: The Bin class contains the logic for calling generate_puppetfile at the command line
   class Bin
     Module_regex = Regexp.new("mod ['\"]([a-z0-9_]+\/[a-z0-9_]+)['\"](, ['\"](\\d\.\\d\.\\d)['\"])?", Regexp::IGNORECASE)
-    @options = {}
+    @options = {}    # Options hash
+    @workspace = nil # Working directory for module download and inspection
+    Silence   = '>/dev/null 2>&1 '
 
     # Public: Initialize a new GeneratePuppetfile::Bin
     #
@@ -30,7 +32,7 @@ module GeneratePuppetfile
       helpmsg = "generate-puppetfile: try 'generate-puppetfile --help' for more information."
 
       if @args[0].nil? && (! @options[:puppetfile])
-        puts "generate-puppetfile: No modules or existing Puppetfile specified."
+        $stderr.puts "generate-puppetfile: No modules or existing Puppetfile specified."
         puts helpmsg
         return 1
       end
@@ -59,34 +61,78 @@ module GeneratePuppetfile
       list_forge_modules(forge_module_list) if puppetfile_contents && @options[:debug]
       list_extras(puppetfile_contents[:extras]) if puppetfile_contents[:extras] && @options[:debug]
 
-      generate_puppetfile_contents(forge_module_list, extras)
+      unless forge_module_list != [] || puppetfile_contents[:extras] != []
+        $stderr.puts "\nNo valid modules or existing Puppetfile content was found. Exiting.\n\n"
+        return 1
+      end
+
+      create_workspace()
+      @modulepath = "--modulepath #{@workspace} "
+
+      download_modules(forge_module_list)
+      puppetfile_contents = generate_puppetfile_contents(extras)
+
+
+      if @options[:create_puppetfile]
+        create_puppetfile(puppetfile_contents)
+      end
+
+      unless @options[:silent]
+        display_puppetfile(puppetfile_contents)
+      end
+
+      cleanup_workspace()
 
       return 0
     end
 
+    # Public: Display the generated Puppetfile to STDOUT with delimiters
+    def display_puppetfile(puppetfile_contents)
+      puts <<-EOF
+
+Your Puppetfile has been generated. Copy and paste between the markers:
+
+=======================================================================
+#{puppetfile_contents.chomp}
+=======================================================================
+      EOF
+    end
+
+    # Public: Create a Puppetfile on disk
+    # The Puppetfile will be called 'Puppetfile' in the current working directory
+    def create_puppetfile (puppetfile_contents)
+      File.open('Puppetfile', 'w') do |file|
+        file.write puppetfile_contents
+      end
+    end
+
     # Public: Validates that a provided module name is valid.
     def validate (modulename)
       success = (modulename =~ /[a-z0-9_]\/[a-z0-9_]/i)
-      puts "    '#{modulename}' is not a valid module name. Skipping." unless success
+      $stderr.puts "'#{modulename}' is not a valid module name. Skipping." unless success
       success
     end
 
     # Public: Display the list of Forge modules collected.
     def list_forge_modules (module_list)
-      puts "\nListing discovered modules from CLI and/or Puppetfile:\n\n"
-      module_list.each do |name|
-        puts "    #{name}"
+      unless @options[:silent]
+        puts "\nListing discovered modules from CLI and/or Puppetfile:\n\n"
+        module_list.each do |name|
+          puts "    #{name}"
+        end
+        puts ""
       end
-      puts ""
     end
 
     # Public: Display the list of extra statements found in the Puppetfile.
     def list_extras (extras)
-      puts "\nExtras found in the existing Puppetfile:\n\n"
-      extras.each do |line|
-        puts "    #{line}"
+      unless @options[:silent] || (extras == [])
+        puts "\nExtras found in the existing Puppetfile:\n\n"
+        extras.each do |line|
+          puts "    #{line}"
+        end
+        puts ""
       end
-      puts ""
     end
 
     # Public: Read and parse the contents of an existing Puppetfile
@@ -113,64 +159,65 @@ module GeneratePuppetfile
       puppetfile_contents
     end
 
-    # Public: Generate a new Puppetfile's contents based on a list of modules
-    # and any extras found in an existing Puppetfile.
+    # Public: Download the list of modules and their dependencies to @workspace
     #
     # module_list is an array of forge module names to be downloaded
-    # extras is an array of strings
-    def generate_puppetfile_contents (module_list, extras)
-      unless module_list != [] || extras != []
-	puts "\nNo valid modules or existing Puppetfile content was found. Exiting.\n\n"
-	exit 1
-      end
-
-      workspace = Dir.mktmpdir
-
-      modulepath = "--modulepath #{workspace.chomp} "
-      silence    = '>/dev/null 2>&1 '
-
-      puts "\nInstalling modules. This may take a few minutes.\n"
+    def download_modules(module_list)
+      puts "\nInstalling modules. This may take a few minutes.\n" unless @options[:silent]
       module_list.each do |name|
         command  = "puppet module install #{name} "
-        command += modulepath + silence
+        command += @modulepath + Silence
 
         system(command)
       end
+    end
+    
+    # Public: generate the list of modules in Puppetfile format from the @workspace
+    def generate_module_output ()
+      module_output = `puppet module list #{@modulepath} 2>/dev/null`
+
+      module_output.gsub!(/\x1B\[([0-9]{1,2}(;[0-9]{1,2})?)?[m|K]/, '') # Strips ANSI color codes
+      module_output.gsub!(/^\/.*$/, '')
+      module_output.gsub!(/-/,      '/')
+      module_output.gsub!(/├── /,   "mod '")
+      module_output.gsub!(/└── /,   "mod '")
+      module_output.gsub!(/ \(v/,   "', '")
+      module_output.gsub!(/\)$/,    "'")
+      module_output.gsub!(/^$\n/,   '')
+
+      module_output
+    end
 
-      puppetfile_header = <<-EOF
+    # Public: Generate a new Puppetfile's contents based on a list of modules
+    # and any extras found in an existing Puppetfile.
+    #
+    # extras is an array of strings
+    def generate_puppetfile_contents (extras)
+
+      puppetfile_contents = <<-EOF
 forge 'http://forge.puppetlabs.com'
 
 # Modules discovered by generate-puppetfile
       EOF
 
-      puppetfile_body = `puppet module list #{modulepath} 2>/dev/null`
-
-      puppetfile_body.gsub!(/\x1B\[([0-9]{1,2}(;[0-9]{1,2})?)?[m|K]/, '') # Strips ANSI color codes
-      puppetfile_body.gsub!(/^\/.*$/, '')
-      puppetfile_body.gsub!(/-/,      '/')
-      puppetfile_body.gsub!(/├── /,   "mod '")
-      puppetfile_body.gsub!(/└── /,   "mod '")
-      puppetfile_body.gsub!(/ \(v/,   "', '")
-      puppetfile_body.gsub!(/\)$/,    "'")
-      puppetfile_body.gsub!(/^$\n/,   '')
+      puppetfile_contents += generate_module_output()
 
-      puppetfile_footer = "# Discovered elements from existing Puppetfile\n"
+      puppetfile_contents += "# Discovered elements from existing Puppetfile\n" unless extras == []
       extras.each do |line|
-        puppetfile_footer += "#{line}"
-      end if extras
+        puppetfile_contents += "#{line}"
+      end unless extras == []
 
-      puts <<-EOF
-
-Your Puppetfile has been generated. Copy and paste between the markers:
+      puppetfile_contents
+    end
 
-=======================================================================
-#{puppetfile_header}
-#{puppetfile_body}
-#{puppetfile_footer}
-=======================================================================
-      EOF
+    # Public: Create a temporary workspace for module manipulation
+    def create_workspace()
+      @workspace = (Dir.mktmpdir).chomp
+    end
 
-      FileUtils.rm_rf(workspace)
+    # Public: Remove the workspace (with prejudice)
+    def cleanup_workspace ()
+      FileUtils.rm_rf(@workspace)
     end
   end
 end

data/lib/generate_puppetfile/optparser.rb

@@ -21,12 +21,22 @@ module GeneratePuppetfile
 	  options[:puppetfile] = file
         end
 
+	opts.on('-c', '--create_puppetfile', 'Create a Puppetfile in the working directory. Warning: overwrites any existing file with the same name.') do
+	  options[:create_puppetfile] = true
+	end
+
+	opts.on('-s', '--silent', 'Run in silent mode. Supresses all non-debug output. Adds the -c flag automatically.') do
+	  options[:silent] = true
+	  options[:create_puppetfile] = true
+	end
+
 	opts.on('-d', '--debug', 'Enable debug logging') do
 	  options[:debug] = true
 	end
 
 	opts.on_tail('-v', '--version', 'Show version') do
 	  puts "generate-puppetfile v#{GeneratePuppetfile::VERSION}"
+	  exit
 	end
       end
      

data/lib/generate_puppetfile/version.rb

@@ -1,3 +1,3 @@
 module GeneratePuppetfile
-  VERSION = '0.9.3'
+  VERSION = '0.9.4'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: generate-puppetfile
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 0.9.4
 platform: ruby
 authors:
 - Rob Nelson