puppetfile_editor 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f3364e07c1a49414ed25fecced5c31afd13a15be
-  data.tar.gz: 3377a602b97e701d1f21a8dae430d9da65e418e4
+  metadata.gz: 0dd06f4116c562fe9db2c70ee918c1a178cffb2c
+  data.tar.gz: 51ef0ec280c7fbcbb2a225528579471b1451f05b
 SHA512:
-  metadata.gz: 4768b06d6ea7345a02cdd938716fc61a44cbb156dd2fcf056eaff6bb79adc98670adb09c85b5090bfc86911642e941df02a4a447a47815cff93cdc2481b8f14d
-  data.tar.gz: a3f6515c3d4ae5cd647e6fe8b25311d49e06de5b63abff8d44418e578cdc1769a90eb8e76a3d44353c17c3acf88438b6a5d4f7098767707b5dacd4b23a7c726a
+  metadata.gz: 227795078fcb7cc4b46ba31a482aec3cfd488a92c36f8c26bc4f0e7d06e9b133854c41d37dfca389ef9410fe8f09fc247655ee4ae951a68b0ec370ad0cbda84a
+  data.tar.gz: 8e982d0e9ac8dab8851de23d0056f0a67c4741a8dec1b7ff6eecd53e43f2baef092399a44854b42a10b970683675e05f2961de67b83302dd9cd81dcdf40e6694

data/CHANGELOG.md

@@ -0,0 +1,30 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [0.3.0] - 2017-09-27
+### Added
+- Puppetfile can be instantiated using provided contents.
+- `Puppetfile#compare_with` method.
+
+### Changed
+- Removed named parameters from `Puppetfile#initialize` to support older Rubies.
+- Moved all IO to `Puppetfile::CLI`.
+
+### Fixed
+- Proper status for `kept at ...` messages.
+- Return earlier on `:matched` status so that no re-ordering of parameters can occur.
+- Various CLI logic issues.
+
+### Removed
+- No more old_hashes support.
+
+## [0.2.0] - 2017-09-25
+### Added
+- Merge function.
+
+## [0.1.0] - 2017-09-20 [YANKED]
+### Added
+- Initial release.

data/bin/pfile

@@ -8,14 +8,7 @@ filename = File.basename(__FILE__)
 # Display help if no arguments are specified
 ARGV.push('-h') if ARGV.empty?
 
-options = { puppetfile: 'Puppetfile' }
-OptionParser.new do |parser|
-  parser.banner = "Usage: #{filename} [options] [command] [command options]"
-  parser.on('-v', '--[no-]verbose', 'Run verbosely') { |v| options[:verbose] = v }
-  parser.on('-f', '--filename PUPPETFILE', 'Path to your Puppetfile.') do |puppetfile|
-    options[:puppetfile] = puppetfile
-  end
-end.order!
+options = { puppetfile: './Puppetfile' }
 
 subcommands = {
   'edit'   => OptionParser.new do |parser|
@@ -24,12 +17,7 @@ subcommands = {
       options[:name] = setting
     end
     parser.on('-u', '--update PARAM=VALUE', 'What to update') do |setting|
-      if (match = setting.match(/^(\w+)=([^=]+)$/))
-        options[:param], options[:value] = match[1], match[2]
-      else
-        warn 'Version must match PARAM=VALUE pattern'
-        exit 1
-      end
+      options[:version] = setting
     end
   end,
   'format' => OptionParser.new do |parser|
@@ -69,6 +57,20 @@ subcommands = {
   end,
 }
 
+OptionParser.new do |parser|
+  parser.banner = "Usage: #{filename} [options] [command] [command options]"
+  parser.separator ''
+  parser.separator ' Supported commands:'
+  subcommands.keys.each do |command|
+    parser.separator "  * #{command}"
+  end
+  parser.separator ''
+  parser.separator ' Supported global options:'
+  parser.on('-p', '--puppetfile PUPPETFILE', 'Path to your Puppetfile.') do |puppetfile|
+    options[:puppetfile] = puppetfile
+  end
+end.order!
+
 command = ARGV.shift
 subcommands[command].order!
 

data/lib/puppetfile_editor/cli.rb

@@ -4,23 +4,32 @@ module PuppetfileEditor
   # CLI methods
   class CLI
     def initialize(pfile_path)
-      @pfile  = PuppetfileEditor::Puppetfile.new(path: pfile_path)
+      @pfile  = PuppetfileEditor::Puppetfile.new(pfile_path)
       @logger = PuppetfileEditor::Logging.new
       begin
         @pfile.load
       rescue IOError, NoMethodError => e
-        warn_and_exit(e.message)
+        @logger.log_and_exit(e.message)
+      rescue StandardError => e
+        @logger.log_and_exit(e.message)
       end
     end
 
     def edit(opts)
       opts[:value] = :latest if opts[:value] == 'latest'
-      @pfile.update_module(
-        opts[:name],
-        opts[:param],
-        opts[:value],
-        opts[:verbose],
-      )
+      @logger.log_and_exit('Please specify module name') unless opts[:name].is_a?(String)
+      @logger.log_and_exit('Please specify version') unless opts[:version].is_a?(String)
+      if (match = opts[:version].match(/^(\w+)=([^=]+)$/))
+        param = match[1]
+        value = match[2]
+      else
+        @logger.log_and_exit('Version must match PARAM=VALUE pattern')
+      end
+      begin
+        @pfile.update_module(opts[:name], param, value)
+      rescue StandardError => e
+        @logger.log_and_exit(e.message)
+      end
       @pfile.dump
     end
 
@@ -49,8 +58,12 @@ module PuppetfileEditor
     end
 
     def merge(opts)
-      @pfdata = PuppetfileEditor::Puppetfile.new(from_stdin: true)
-      @pfdata.load
+      @pfdata = PuppetfileEditor::Puppetfile.new(nil, true)
+      begin
+        @pfdata.load
+      rescue SyntaxError
+        @logger.log_and_exit('Format error.')
+      end
       new_mod_types = @pfdata.modules.values.group_by(&:type)
       new_mod_types.each do |mod_type, mods|
         puts "\n   #{@pfile.module_sections[mod_type]}\n\n"
@@ -61,14 +74,11 @@ module PuppetfileEditor
         indent = mods.map(&:name).max_by(&:length).length
         mods.each do |mod|
           if @pfile.modules.key? mod.name
-            begin
-              @pfile.modules[mod.name].merge_with(mod, opts[:force])
-              @logger.module_log(mod.name, indent, @pfile.modules[mod.name].message, @pfile.modules[mod.name].status)
-            rescue StandardError => e
-              @logger.module_log(mod.name, indent, e.message, @pfile.modules[mod.name].status)
-            end
+            @pfile.modules[mod.name].merge_with(mod, opts[:force])
+            @logger.mod_message(@pfile.modules[mod.name], indent)
           else
-            @logger.module_log(mod.name, indent, 'does not exist in source Puppetfile', :not_found)
+            mod.set_message('does not exist in source Puppetfile', :not_found)
+            @logger.mod_message(mod, indent)
           end
         end
       end
@@ -94,6 +104,7 @@ module PuppetfileEditor
         not_found:       "[ \e[31;1mx\e[0m ]",
         type_mismatched: "[ \e[31;1mx\e[0m ]",
         wont_upgrade:    "[ \e[33;1m!\e[0m ]",
+        warn:            "[ \e[31;1m!!\e[0m ]",
         undef:           '',
       }
     end
@@ -107,8 +118,14 @@ module PuppetfileEditor
       puts "#{status} #{message}"
     end
 
-    def module_log(mod_name, indent, message, message_type = :undef)
-      log("#{mod_name.ljust(indent)} => #{message}", message_type)
+    def log_and_exit(message)
+      log(message, :warn)
+      exit 1
     end
+
+    def mod_message(mod, indent)
+      log("#{mod.name.ljust(indent)} => #{mod.message}", mod.status)
+    end
+
   end
 end

data/lib/puppetfile_editor/module.rb

@@ -31,43 +31,45 @@ module PuppetfileEditor
     def set(param, newvalue, force = false)
       case @type
         when :hg, :git
-          if %w[branch tag ref].include? param
+          if !force && (@params.key?(:branch) || @params.key?(:ref))
+            set_message("kept at (#{full_version})", :wont_upgrade)
+          elsif !%w[branch tag ref].include? param
+            set_message("only 'branch', 'tag', and 'ref' are supported for '#{@type}' modules.", :unsupported)
+          else
+            set_message("updated (#{full_version} to #{param}: #{newvalue}", :updated)
             @params.delete :branch
             @params.delete :tag
             @params.delete :ref
             @params[param.to_sym] = newvalue
             calculate_indent
-          else
-            raise StandardError, "Only 'branch', 'tag', and 'ref' are supported for '#{@type}' modules."
           end
         when :forge
           if param == 'version'
             @params[:version] = newvalue
+            set_message("successfully set #{param} to #{newvalue} for #{@name}.", :updated)
           else
-            raise StandardError, "Only 'version' is supported for forge modules."
+            set_message("only 'version' is supported for forge modules.", :unsupported)
           end
         else
-          raise StandardError, "Editing params for '#{@type}' modules is not supported."
+          set_message("editing params for '#{@type}' modules is not supported.", :unsupported)
       end
     end
 
     def merge_with(mod, force = false)
       unless mod.type == @type
-        @status = :type_mismatched
-        raise(StandardError, "type mismatch ('#{@type}' vs '#{mod.type}')")
+        set_message("type mismatch ('#{@type}' vs '#{mod.type}')", :type_mismatched)
       end
       case @type
         when :hg, :git
           new = mod.params.reject { |param, _| param.eql? @type }
           if !force && new.keys == [:tag] && (@params.key?(:branch) || @params.key?(:ref))
-            raise(StandardError, "kept at #{full_version}")
+            set_message("kept at #{full_version}", :wont_upgrade)
           end
           if full_version == mod.full_version
-            @message = "versions match (#{full_version})"
-            @status  = :matched
+            set_message("versions match (#{full_version})", :matched)
+            return
           else
-            @message = "updated (#{full_version} to #{mod.full_version})"
-            @status  = :updated
+            set_message("updated (#{full_version} to #{mod.full_version})", :updated)
           end
           @params.delete_if { |param, _| [:branch, :tag, :ref].include? param }
           @params.merge!(new)
@@ -75,25 +77,22 @@ module PuppetfileEditor
         when :forge
           unless force
             if mod.params.nil? or mod.params.is_a? Symbol
-              @status = :wont_upgrade
-              raise(StandardError, "won't upgrade to #{mod.full_version}")
+              set_message("won't upgrade to #{mod.full_version}", :wont_upgrade)
             end
           end
           if full_version == mod.full_version
-            @message = "versions match (#{full_version})"
-            @status  = :matched
+            set_message("versions match (#{full_version})", :matched)
+            return
           else
-            @message = "updated (#{full_version} to #{mod.full_version})"
-            @status  = :updated
+            set_message("updated (#{full_version} to #{mod.full_version})", :updated)
           end
           @params = mod.params
         else
-          @status = :skipped
-          raise(StandardError, 'only git, forge, and hg modules are supported for merging')
+          set_message('only git, forge, and hg modules are supported for merging', :skipped)
       end
     end
 
-    def dump(old_hashes = false)
+    def dump
       output = []
       case @type
         when :hg, :git
@@ -104,7 +103,7 @@ module PuppetfileEditor
                     else
                       "'#{param_value}'"
                     end
-            param = old_hashes ? ":#{param_name.to_s.ljust(@indent - 1)} =>" : "#{param_name}:".ljust(@indent)
+            param = "#{param_name}:".ljust(@indent)
             output.push "    #{param} #{value}"
           end
         when :local
@@ -136,6 +135,11 @@ module PuppetfileEditor
       end
     end
 
+    def set_message(message, status)
+      @message = message
+      @status = status
+    end
+
     private
 
     def parse_title(title)

data/lib/puppetfile_editor/puppetfile.rb

@@ -14,10 +14,10 @@ module PuppetfileEditor
     attr_reader :module_sections
 
     # @param [String] path path to Puppetfile
-    def initialize(path: 'Puppetfile', from_stdin: false, old_hashes: false)
+    def initialize(path = 'Puppetfile', from_stdin = false, contents = nil)
       @puppetfile_path = path
       @from_stdin      = from_stdin
-      @old_hashes      = old_hashes
+      @contents        = contents
       @modules         = {}
       @loaded          = false
       @forge           = nil
@@ -34,9 +34,10 @@ module PuppetfileEditor
     def load
       puppetfile_contents = if @from_stdin
                               $stdin.gets(nil).chomp
+                            elsif @contents
+                              @contents
                             else
-                              raise(IOError, "Puppetfile #{@puppetfile_path} missing or unreadable") unless File.readable?(@puppetfile_path)
-
+                              raise(IOError, "'#{@puppetfile_path}' is missing or unreadable") unless File.readable?(@puppetfile_path)
                               File.read @puppetfile_path
                             end
 
@@ -57,7 +58,7 @@ module PuppetfileEditor
         next unless module_list.any?
         contents.push "# #{module_comment}"
         module_list.values.sort_by(&:name).each do |mod|
-          contents.push mod.dump(@old_hashes)
+          contents.push mod.dump
         end
         contents.push ''
       end
@@ -69,18 +70,35 @@ module PuppetfileEditor
       File.write(@puppetfile_path, generate_puppetfile) if @loaded
     end
 
-    def update_module(name, param, value, verbose = false)
+    def update_module(name, param, value)
       if @modules.key? name
-        begin
-          @modules[name].set(param, value)
-          puts "Successfully set #{param} to #{value} for #{name}." if verbose
-        rescue StandardError => e
-          warn e.message
-          exit 1
-        end
+        @modules[name].set(param, value)
       else
-        warn "Module #{name} does not exist in your Puppetfile"
+        raise StandardError, "Module #{name} does not exist in your Puppetfile"
+      end
+    end
+
+    def compare_with(pf)
+      diff = {}
+      pf.modules.each do |mod_name, mod|
+        next unless [:git, :hg, :forge].include? mod.type
+        version_key = @type == :forge ? :version : :tag
+
+        unless @modules.key? mod_name
+          if mod.params.key?(version_key)
+            diff[mod_name] = { new: mod.params[version_key] }
+          end
+          next
+        end
+
+        local_mod = @modules[mod_name]
+
+        next unless mod.type == local_mod.type
+        next unless mod.params.key?(version_key) && local_mod.params.key?(version_key)
+        next if mod.params[version_key] == local_mod.params[version_key]
+        diff[mod_name] = { old: local_mod.params[version_key], new: mod.params[version_key] }
       end
+      diff
     end
 
     # @param [String] name Module name

data/lib/puppetfile_editor/version.rb

@@ -1,3 +1,3 @@
 module PuppetfileEditor
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.3.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppetfile_editor
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Eugene Piven
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-25 00:00:00.000000000 Z
+date: 2017-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -61,6 +61,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - README.md
 - bin/pfile
 - lib/puppetfile_editor.rb