generate-puppetfile 0.9.8 → 0.9.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bd48413a63df74c9306f1d5c0915873b374dd8d2
-  data.tar.gz: 907880161d8a1fef4710d735e6dbe3ffb475317a
+  metadata.gz: 4d1d05ed7199555f2bb1b26860c8f4309cc37361
+  data.tar.gz: 80e0478b383aed1a39e634a4f4174249f7ddef99
 SHA512:
-  metadata.gz: 2ff6eec9ffbc414e01ae20e80451a576e682a78b4af3c58f81955895291b84165e03427f77521e97621a710579e933943460ea1b54aa6316c2fd17c2a23bd03b
-  data.tar.gz: d46f2292a2ab1d97317c4a36ae4699dce52106835043ce03642732434a0a7c79b6468ddcc7ea308cd4f5b4f3f16f054dc6496aacc0430d8987fedab970fbd316
+  metadata.gz: 064fd4d390492aa6825a68ac9b19f570e81f231c70046df254a74fafcb0e1eb63c2e9e2ee5e2cc4fcf0a3ede788c13f9932e822497b328b6c17b3b23bf89c481
+  data.tar.gz: 0e29d6afbd45da58a9d9458bbec782255e6b9e48f95f996fd6bb31a977ea477619cf90c789491376871a08a0f1ac3ba7320f4336564dcca40dfcceb2fcd66640

data/lib/generate_puppetfile/bin.rb

@@ -5,16 +5,18 @@ require 'fileutils'
 require 'tempfile'
 require 'json'
 require 'mkmf'
+require 'colorize'
 
 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 hash
-    @workspace = nil # Working directory for module download and inspection
-    Silence   = '>/dev/null 2>&1 '
-    Puppetfile_Header = '# Modules discovered by generate-puppetfile'
-    Extras_Note = '# Discovered elements from existing Puppetfile'
+    @options = {}     # Options hash
+    @workspace = nil  # Working directory for module download and inspection
+    @module_data = {} # key: modulename, value: version number
+    Silence = ('>' + File::NULL.to_str + ' 2>&1 ').freeze
+    Puppetfile_Header = '# Modules discovered by generate-puppetfile'.freeze
+    Extras_Note = '# Discovered elements from existing Puppetfile'.freeze
 
     # Public: Initialize a new GeneratePuppetfile::Bin
     #
@@ -36,28 +38,28 @@ module GeneratePuppetfile
       helpmsg = "generate-puppetfile: try 'generate-puppetfile --help' for more information."
 
       if @args[0].nil? && (! @options[:puppetfile])
-        $stderr.puts "generate-puppetfile: No modules or existing Puppetfile specified."
+        $stderr.puts 'generate-puppetfile: No modules or existing Puppetfile specified.'.red
         puts helpmsg
         return 1
       end
 
-      if (! verify_puppet_exists())
-        $stderr.puts "generate-puppetfile: Could not find a 'puppet' executable."
-        $stderr.puts "  Please make puppet available in your path before trying again."
+      unless verify_puppet_exists
+        $stderr.puts "generate-puppetfile: Could not find a 'puppet' executable.".red
+        $stderr.puts '  Please make puppet available in your path before trying again.'.red
         return 1
       end
 
-      forge_module_list = Array.new
+      forge_module_list = []
 
       if @args
         puts "\nProcessing modules from the command line...\n\n" if @options[:debug]
-        cli_modules = Array.new
+        cli_modules = []
         @args.each do |modulename|
-          validate(modulename) && (cli_modules.push(modulename))
+          validate(modulename) && cli_modules.push(modulename)
         end
       end
 
-      puppetfile_contents = Hash.new
+      puppetfile_contents = {}
       extras = []
       if @options[:puppetfile]
         puts "\nProcessing the puppetfile '#{@options[:puppetfile]}'...\n\n" if @options[:debug]
@@ -71,33 +73,29 @@ module GeneratePuppetfile
       list_extras(puppetfile_contents[:extras]) if puppetfile_contents[:extras] && @options[:debug]
 
       unless forge_module_list != [] || puppetfile_contents[:extras] != []
-        $stderr.puts "\nNo valid modules or existing Puppetfile content was found. Exiting.\n\n"
+        $stderr.puts "\nNo valid modules or existing Puppetfile content was found. Exiting.\n\n".red
         return 1
       end
 
-      create_workspace()
+      create_workspace
       @modulepath = "--modulepath #{@workspace} "
 
-      download_modules(forge_module_list)
+      return 2 if download_modules(forge_module_list) == 2
+      @module_data = generate_module_data
       puppetfile_contents = generate_puppetfile_contents(extras)
 
+      create_puppetfile(puppetfile_contents) if @options[:create_puppetfile]
 
-      if @options[:create_puppetfile]
-        create_puppetfile(puppetfile_contents)
-      end
-
-      unless @options[:silent]
-        display_puppetfile(puppetfile_contents)
-      end
+      display_puppetfile(puppetfile_contents) unless @options[:silent]
 
       if @options[:create_fixtures]
-        fixtures_data = generate_fixtures_data()
+        fixtures_data = generate_fixtures_data
         write_fixtures_data(fixtures_data)
       end
 
-      cleanup_workspace()
+      cleanup_workspace
 
-      return 0
+      0
     end
 
     # Public: Display the generated Puppetfile to STDOUT with delimiters
@@ -114,51 +112,51 @@ Your Puppetfile has been generated. Copy and paste between the markers:
 
     # Public: Create a Puppetfile on disk
     # The Puppetfile will be called 'Puppetfile' in the current working directory
-    def create_puppetfile (puppetfile_contents)
+    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)
+    def validate(modulename)
       success = (modulename =~ /[a-z0-9_]\/[a-z0-9_]/i)
-      $stderr.puts "'#{modulename}' is not a valid module name. Skipping." unless success
+      $stderr.puts "'#{modulename}' is not a valid module name. Skipping.".red unless success
       success
     end
 
     # Public: Display the list of Forge modules collected.
-    def list_forge_modules (module_list)
+    def list_forge_modules(module_list)
       unless @options[:silent]
         puts "\nListing discovered modules from CLI and/or Puppetfile:\n\n"
         module_list.each do |name|
           puts "    #{name}"
         end
-        puts ""
+        puts ''
       end
     end
 
     # Public: Display the list of extra statements found in the Puppetfile.
-    def list_extras (extras)
+    def list_extras(extras)
       unless @options[:silent] || (extras == [])
         puts "\nExtras found in the existing Puppetfile:\n\n"
         extras.each do |line|
           puts "    #{line}"
         end
-        puts ""
+        puts ''
       end
     end
 
     # Public: Read and parse the contents of an existing Puppetfile
-    def read_puppetfile (puppetfile)
+    def read_puppetfile(puppetfile)
       puppetfile_contents = {
-        :modules => Array.new,
-        :extras  => Array.new,
+        modules: [],
+        extras: []
       }
 
       File.foreach(puppetfile) do |line|
         if Module_Regex.match(line)
-          name = $1
+          name = Regexp.last_match(1)
           print "    #{name} looks like a forge module.\n" if @options[:debug]
           puppetfile_contents[:modules].push(name)
         else
@@ -175,7 +173,7 @@ Your Puppetfile has been generated. Copy and paste between the markers:
     end
 
     # Public: Verify that Puppet is available in the path
-    def verify_puppet_exists()
+    def verify_puppet_exists
       MakeMakefile::Logging.instance_variable_set(:@logfile, File::NULL)
       find_executable0('puppet')
     end
@@ -184,13 +182,12 @@ Your Puppetfile has been generated. Copy and paste between the markers:
     #
     # module_list is an array of forge module names to be downloaded
     def download_modules(module_list)
-      puts "\nInstalling modules. This may take a few minutes.\n" unless @options[:silent]
+      puts "\nInstalling modules. This may take a few minutes.\n\n" unless @options[:silent]
       module_list.each do |name|
-        if !_download_module(name)
-          $stderr.puts "There was a problem with the module name '#{name}'."
-          $stderr.puts "  Check that module exists as you spelled it and/or your connectivity to the puppet forge."
-          exit 2
-        end
+        next if _download_module(name)
+        $stderr.puts "There was a problem with the module name '#{name}'.".red
+        $stderr.puts '  Check that module exists as you spelled it and/or your connectivity to the puppet forge.'.red
+        return 2
       end
     end
 
@@ -204,20 +201,33 @@ Your Puppetfile has been generated. Copy and paste between the markers:
       puts "Calling '#{command}'" if @options[:debug]
       system(command)
     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`
+
+    # Public: generate the module data the @workspace
+    def generate_module_data
+      command = "puppet module list #{@modulepath} 2>#{File::NULL}"
+      puts "Calling '#{command}'" if @options[:debug]
+      module_output = `#{command}`
 
       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/,   '')
+      modules = {}
+      module_output.each_line do |line|
+        next unless line =~ / \(v/
+        line.tr!('-', '/')
+        line.gsub!(/^\S* /, '')
+        line += line
+        name, version = line.match(/(\S+) \(v(.+)\)/).captures
+        modules[name] = version
+        $stderr.puts "Module #{name} has a version of #{version}, it may be deprecated. For more information, visit https://forge.puppet.com/#{name}".blue if version =~ /999/ and ! @options[:silent]
+      end
+      modules
+    end
 
+    # Public: generate the list of modules in Puppetfile format from the @workspace
+    def generate_forge_module_output
+      module_output = ''
+      @module_data.keys.each do |modulename|
+        module_output += "mod #{modulename}, '#{@module_data[modulename]}'\n"
+      end
       module_output
     end
 
@@ -225,36 +235,35 @@ Your Puppetfile has been generated. Copy and paste between the markers:
     # and any extras found in an existing Puppetfile.
     #
     # extras is an array of strings
-    def generate_puppetfile_contents (extras)
-
+    def generate_puppetfile_contents(extras)
       puppetfile_contents = <<-EOF
 forge 'http://forge.puppetlabs.com'
 
 #{Puppetfile_Header}
       EOF
 
-      puppetfile_contents += generate_module_output()
+      puppetfile_contents += generate_forge_module_output
 
       puppetfile_contents += "#{Extras_Note}\n" unless extras == []
       extras.each do |line|
-        puppetfile_contents += "#{line}"
+        puppetfile_contents += line.to_s
       end unless extras == []
 
       puppetfile_contents
     end
 
     # Public: Create a temporary workspace for module manipulation
-    def create_workspace()
-      @workspace = (Dir.mktmpdir).chomp
+    def create_workspace
+      @workspace = Dir.mktmpdir.chomp
     end
 
     # Public: Remove the workspace (with prejudice)
-    def cleanup_workspace ()
+    def cleanup_workspace
       FileUtils.rm_rf(@workspace)
     end
 
     # Public: Generate a simple fixtures file.
-    def generate_fixtures_data ()
+    def generate_fixtures_data
       puts "\nGenerating .fixtures.yml using module name #{@options[:modulename]}" unless @options[:silent]
 
       # Header for fixtures file creates a symlink for the current module"
@@ -264,27 +273,24 @@ fixtures:
     #{@options[:modulename]}: "\#{source_dir}"
       EOF
 
-
-      module_directories = Dir.glob("#{@workspace}/*")
-      if (module_directories != [])
-        fixtures_data += "  repositories:\n"
+      fixtures_data += "  forge_modules:\n" if @module_data != {}
+      @module_data.keys.each do |modulename|
+        shortname = modulename.split('/')[1]
+        version = @module_data[modulename]
+        fixtures_data += <<-EOF
+    #{shortname}:
+      repo: "#{modulename}"
+      ref: "#{version}"
+        EOF
       end
-      module_directories.each do |module_directory|
-        name = File.basename(module_directory)
-        file = File.read("#{module_directory}/metadata.json")
-        source = (JSON.parse(file))["source"]
-        fixtures_data += "    #{name}: #{source}\n"
-        puts "Found a module '#{name}' with a project page of #{source}." if @options[:debug]
-      end unless module_directories == []
 
       fixtures_data
     end
 
-    def write_fixtures_data (data)
+    def write_fixtures_data(data)
       File.open('.fixtures.yml', 'w') do |file|
         file.write data
       end
     end
-
   end
 end

data/lib/generate_puppetfile/optparser.rb

@@ -13,7 +13,7 @@ module GeneratePuppetfile
       options[:modulename] = 'profile'
 
       opts = OptionParser.new do |opts|
-        opts.banner = "generate-puppetfile [OPTIONS] [<MODULE> ... <MODULE>]"
+        opts.banner = 'generate-puppetfile [OPTIONS] [<MODULE> ... <MODULE>]'
 
         opts.on('-p', '--puppetfile FILE', 'Name of existing Puppetfile to verify and update') do |file|
           unless File.readable?(file)
@@ -50,7 +50,7 @@ module GeneratePuppetfile
           exit
         end
       end
-     
+
       opts.parse!(args)
       options
     end

data/lib/generate_puppetfile/version.rb

@@ -1,3 +1,3 @@
 module GeneratePuppetfile
-  VERSION = '0.9.8'
+  VERSION = '0.9.9'.freeze
 end

metadata

@@ -1,15 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: generate-puppetfile
 version: !ruby/object:Gem::Version
-  version: 0.9.8
+  version: 0.9.9
 platform: ruby
 authors:
 - Rob Nelson
+- Joseph Yaworski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-16 00:00:00.000000000 Z
+date: 2016-06-14 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +81,34 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1'
+- !ruby/object:Gem::Dependency
+  name: puppet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.39.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.39.0
 description: Generate a Puppetfile for use with r10k based on an existing file or
   a list of modules.
 email: rnelson0@gmail.com
@@ -92,7 +135,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
@@ -105,3 +148,4 @@ signing_key:
 specification_version: 4
 summary: Generate a Puppetfile
 test_files: []
+has_rdoc: