generate-puppetfile 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf16afea209bd8ac2e30eed90aeb581f0bce4465
-  data.tar.gz: 58974916249c3e57b4c91f615bea19a2ac9a463c
+  metadata.gz: 4796755a11eed130c7ffdf5587687d38ec0d903f
+  data.tar.gz: fb597256b5e7283a42354cdf13fe9a8b572d6725
 SHA512:
-  metadata.gz: ccf96edd51e4c63a367ba622d35b05f5e46f575d5bcd2132c40e0693f09f0794e2518119e5d6c1991e46986e2433f5d13ced307268a63584bf99d2bd82a02688
-  data.tar.gz: dbd28f66578958bfa335fbaa9716df6a3cd1c0e09f4458584bb2eae794f7c6dcdc75795bcdf9e96ad1e4ade7f8dd31b46c7843d637ff428e832d0f496ed2e891
+  metadata.gz: 09b2664d006c404941337f80b7a35c3591804ef05b5a594dd446e8fc290319a0162c2075dd49bd6d3ad2de48ace8229c6038020185ceb73f31b64257d398e1cc
+  data.tar.gz: b8ba776dd3e63f6feb081110eb28eb3aae59433388c2bafd03d4e91fa57d53ec5ca9705ec9e487f3fed5664aeceaa3c1ad3f79197af180f68b82a377c49cba21

data/lib/generate_puppetfile/bin.rb

@@ -10,7 +10,7 @@ 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)
+    Module_Regex = Regexp.new("mod ['\"]([a-z0-9_]+\/[a-z0-9_]+)['\"](,\\s+['\"](\\d+\.\\d+\.\\d+)['\"])?", Regexp::IGNORECASE)
     @options = {}         # Options hash
     @workspace = nil      # Working directory for module download and inspection
     @module_data = {}     # key: modulename, value: version number
@@ -38,26 +38,46 @@ module GeneratePuppetfile
 
       helpmsg = "generate-puppetfile: try 'generate-puppetfile --help' for more information."
 
+      if (@options[:fixtures_only] && ! @options[:puppetfile] )
+        $stderr.puts "generate-puppetfile: --fixtures-only is only valid when a '-p <Puppetfile>' is used as well.\n".red
+        puts helpmsg
+        return 1
+      end
+
       if @args[0].nil? && (! @options[:puppetfile])
-        $stderr.puts 'generate-puppetfile: No modules or existing Puppetfile specified.'.red
+        $stderr.puts "generate-puppetfile: No modules or existing Puppetfile specified.\n".red
         puts helpmsg
         return 1
       end
 
       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
+        $stderr.puts "  Please make puppet available in your path before trying again.\n".red
         return 1
       end
 
+
       forge_module_list = []
 
+      # When using --fixtures-only, simply parse the provided Puppetfile and get out
+      if @options[:fixtures_only]
+        @module_data = generate_module_data_from_Puppetfile
+        fixtures_data = generate_fixtures_data
+        write_fixtures_data(fixtures_data)
+        return 0
+      end
+
+      # For everything else, run through the whole thing
       if @args
         puts "\nProcessing modules from the command line...\n\n" if @options[:debug]
         cli_modules = []
         @args.each do |modulename|
           validate(modulename) && cli_modules.push(modulename)
         end
+        if cli_modules == [] && ! @options[:puppetfile]
+          $stderr.puts "No valid modules were found to process.".red
+          return 1
+        end
       end
 
       puppetfile_contents = {}
@@ -82,7 +102,7 @@ module GeneratePuppetfile
       @modulepath = "--modulepath #{@workspace} "
 
       return 2 if download_modules(forge_module_list) == 2
-      @module_data = generate_module_data
+      @module_data = generate_module_data_from_modulepath
       puppetfile_contents = generate_puppetfile_contents(extras)
 
       if @download_errors == ''
@@ -126,7 +146,7 @@ Your Puppetfile has been generated. Copy and paste between the markers:
 
     # Public: Validates that a provided module name is valid.
     def validate(modulename)
-      success = (modulename =~ /[a-z0-9_]\/[a-z0-9_]/i)
+      success = (modulename =~ /[a-z0-9_][\/-][a-z0-9_]/i)
       $stderr.puts "'#{modulename}' is not a valid module name. Skipping.".red unless success
       success
     end
@@ -178,6 +198,32 @@ Your Puppetfile has been generated. Copy and paste between the markers:
       puppetfile_contents
     end
 
+    # Public: Read and parse the contents of an existing Puppetfile
+    def read_puppetfile_with_versions(puppetfile)
+      puppetfile_contents = {
+        modules: [],
+        extras: []
+      }
+
+      File.foreach(puppetfile) do |line|
+        if Module_Regex.match(line)
+          name    = Regexp.last_match(1)
+          version = Regexp.last_match(3)
+          print "    #{name} looks like a forge module.\n" if @options[:debug]
+          puppetfile_contents[:modules].push([name, version])
+        else
+          next if line =~ /^forge/
+          next if line =~ /^\s+$/
+          next if line =~ /#{Puppetfile_Header}/
+          next if line =~ /#{Extras_Note}/
+
+          puppetfile_contents[:extras].push(line)
+        end
+      end
+
+      puppetfile_contents
+    end
+
     # Public: Verify that Puppet is available in the path
     def verify_puppet_exists
       MakeMakefile::Logging.instance_variable_set(:@logfile, File::NULL)
@@ -213,8 +259,8 @@ Your Puppetfile has been generated. Copy and paste between the markers:
       system(command)
     end
 
-    # Public: generate the module data the @workspace
-    def generate_module_data
+    # Public: generate the module data from the modulepath (@workspace)
+    def generate_module_data_from_modulepath
       command = "puppet module list #{@modulepath} 2>#{File::NULL}"
       puts "Calling '#{command}'" if @options[:debug]
       module_output = `#{command}`
@@ -233,6 +279,19 @@ Your Puppetfile has been generated. Copy and paste between the markers:
       modules
     end
 
+    # Public: generate the module data from an existing Puppetfile
+    def generate_module_data_from_Puppetfile
+      puppetfile_contents = read_puppetfile_with_versions(@options[:puppetfile])
+
+      modules = {}
+      puppetfile_contents[:modules].each do |name, version|
+        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 = ''
@@ -260,6 +319,9 @@ forge 'http://forge.puppetlabs.com'
         puppetfile_contents += line.to_s
       end unless extras == []
 
+      # Strip out all contents with --ignore_comments
+      puppetfile_contents.gsub!(/^#.*$\n/, '') if @options[:ignore_comments]
+
       puppetfile_contents
     end
 
@@ -275,8 +337,6 @@ forge 'http://forge.puppetlabs.com'
 
     # Public: Generate a simple fixtures file.
     def generate_fixtures_data
-      puts "\nGenerating .fixtures.yml using module name #{@options[:modulename]}" unless @options[:silent]
-
       # Determine if there are symlinks, either for the default modulename, or for anything in the modulepath
       symlinks = []
       modulepath = ''
@@ -319,12 +379,15 @@ forge 'http://forge.puppetlabs.com'
       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
+        version = @module_data[modulename] 
+        data = <<-EOF
     #{shortname}:
       repo: "#{modulename}"
       ref: "#{version}"
         EOF
+        data.gsub!(/^ *ref.*$\n/, '') unless version != nil
+
+        fixtures_data += data
       end
 
       fixtures_data

data/lib/generate_puppetfile/optparser.rb

@@ -28,11 +28,11 @@ module GeneratePuppetfile
           options[:create_puppetfile] = true
         end
 
-        opts.on('-f', '--create-fixtures', 'Create a .fixtures.yml file in the working directory. This works in a module directory or at the top if your controlrepo..') do
+        opts.on('-f', '--create-fixtures', 'Create a .fixtures.yml file in the working directory. This works in a module directory or at the top of your controlrepo.') do
           options[:create_fixtures] = true
         end
 
-        opts.on('-m', '--modulename NAME', "Name of the module the fixtures file will be used with. Optional, for use with --create-fixtures when used in a module directory. Defaults to 'profile'. ") do |name|
+        opts.on('-m', '--modulename NAME', "Name of the module the fixtures file will be used with. Optional, for use with --create-fixtures when used in a module directory. Defaults to 'profile'.") do |name|
           options[:modulename] = name
         end
 
@@ -45,6 +45,14 @@ module GeneratePuppetfile
           options[:debug] = true
         end
 
+        opts.on_tail('-i', '--ignore-comments', 'Ignore comments') do
+          options[:ignore_comments] = true
+        end
+
+        opts.on_tail('--fixtures-only', 'Create a .fixtures.yml file from an existing Puppetfile. Requires the -p option.') do
+          options[:fixtures_only] = true
+        end
+
         opts.on_tail('-v', '--version', 'Show version') do
           puts "generate-puppetfile v#{GeneratePuppetfile::VERSION}"
           exit

data/lib/generate_puppetfile/version.rb

@@ -1,3 +1,3 @@
 module GeneratePuppetfile
-  VERSION = '0.10.0'.freeze
+  VERSION = '0.11.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: generate-puppetfile
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Rob Nelson
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-06 00:00:00.000000000 Z
+date: 2017-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize