puppetfile_editor 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3012dc52c8fc9e31fd2e05bf696482b5d5151e7e
-  data.tar.gz: db59418ca560a30d01901a5dd6fdbd5b63764935
+  metadata.gz: bc263a5f1856d71645fb70d268488605c16c3525
+  data.tar.gz: 19486c4caa8397f34aa7691917954cc88b35dcd0
 SHA512:
-  metadata.gz: 1d960ef7240383124c2f8dc8cfc569f2b77bc6be49111b776000add14a9f1054c00af65746ccac26065c433ea8c89433e5a7dbfa1c7b0fa2bd57bea1e3a46ebc
-  data.tar.gz: f45048722ddecabc3119a920ce15f60d9db714aa0f832011ccec7c509562eef5ff5fbbb0b618df2ebbed70a37ca7053cea646b5209ec7406d2b9622eb83d9dd9
+  metadata.gz: aad9c5681bc66503bc7521d13313f0ee3be222da26382deeaf24b28736f25305897be3edec8c2d1d175fcac480111c3457f983b8d55454888c535476954848ae
+  data.tar.gz: b3779e4a40716475e33f439281c359d4c8197c846356c0b866265574bbb44a29db210285d79856f3d2789b9fa467812edb199b2e9c2cb1a601ab899852ee23f0

data/CHANGELOG.md

@@ -4,6 +4,10 @@ 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.5.0] - 2017-10-23
+### Added
+- `delete` command for deleting modules from Puppetfile.
+
 ## [0.4.0] - 2017-10-07
 ### Added
 - Support for setting `changeset` for git/hg modules.

data/bin/pfile

@@ -11,7 +11,7 @@ ARGV.push('-h') if ARGV.empty?
 options = { puppetfile: './Puppetfile' }
 
 subcommands = {
-  'edit'   => OptionParser.new do |parser|
+  'edit' => OptionParser.new do |parser|
     parser.banner = "Usage: #{filename} edit [options]"
     parser.on('-m', '--module-name NAME', 'Module name') do |setting|
       options[:name] = setting
@@ -23,7 +23,13 @@ subcommands = {
   'format' => OptionParser.new do |parser|
     parser.banner = "Usage: #{filename} format"
   end,
-  'add'    => OptionParser.new do |parser|
+  'delete' => OptionParser.new do |parser|
+    parser.banner = "Usage: #{filename} format -m MODULENAME"
+    parser.on('-m', '--module-name NAME', 'Module name') do |setting|
+      options[:name] = setting
+    end
+  end,
+  'add' => OptionParser.new do |parser|
     parser.banner = "Usage: #{filename} add [options]"
     parser.on('-m', '--module-name NAME', 'Module name') do |setting|
       options[:name] = setting
@@ -36,7 +42,8 @@ subcommands = {
     end
     parser.on('-u', '--version [PARAM=VALUE]', 'Version of module to add in the form of PARAM=VALUE') do |setting|
       if (match = setting.match(/^(\w+)=([^=]+)$/))
-        options[:param], options[:value] = match[1], match[2]
+        options[:param] = match[1]
+        options[:value] = match[2]
       elsif (match = setting.match(/^\d+(\.\d)*$/))
         options[:version] = match[0]
       else
@@ -45,7 +52,7 @@ subcommands = {
       end
     end
   end,
-  'merge'  => OptionParser.new do |parser|
+  'merge' => OptionParser.new do |parser|
     parser.banner = "Usage: #{filename} merge [options]"
     parser.separator '  Merge existing Puppetfile with another one from STDIN.'
     parser.separator '  Dump the result to STDOUT.'

data/lib/puppetfile_editor/cli.rb

@@ -37,22 +37,29 @@ module PuppetfileEditor
       @pfile.dump
     end
 
+    def delete(opts)
+      warn_and_exit "Module #{opts[:name]} does not exist in your Puppetfile." unless @pfile.modules.key? opts[:name]
+
+      @pfile.delete_module(opts[:name])
+      @pfile.dump
+    end
+
     def add(opts)
       warn_and_exit "Module #{opts[:name]} is already present in your Puppetfile." if @pfile.modules.key? opts[:name]
 
       case opts[:type]
-        when :hg, :git
-          warn_and_exit 'URL must be provided for Git and Hg modules' unless opts.key? :url
-          warn_and_exit 'Version must be provided for Git and Hg modules' unless opts.key? :param
-          opts[:value] = :latest if opts[:value] == 'latest'
-          @pfile.add_module(opts[:name], opts[:type] => opts[:url], opts[:param] => opts[:value])
-        when :local
-          @pfile.add_module(opts[:name], :local)
-        when :forge
-          warn_and_exit 'Version must be provided for Forge modules' unless opts.key? :version
-          @pfile.add_module(opts[:name], opts[:version])
-        else
-          warn_and_exit 'Only hg, git, local, and forge modules are supported at the moment.'
+      when :hg, :git
+        warn_and_exit 'URL must be provided for Git and Hg modules' unless opts.key? :url
+        warn_and_exit 'Version must be provided for Git and Hg modules' unless opts.key? :param
+        opts[:value] = :latest if opts[:value] == 'latest'
+        @pfile.add_module(opts[:name], opts[:type] => opts[:url], opts[:param] => opts[:value])
+      when :local
+        @pfile.add_module(opts[:name], :local)
+      when :forge
+        warn_and_exit 'Version must be provided for Forge modules' unless opts.key? :version
+        @pfile.add_module(opts[:name], opts[:version])
+      else
+        warn_and_exit 'Only hg, git, local, and forge modules are supported at the moment.'
       end
       @pfile.dump
     end
@@ -95,6 +102,9 @@ module PuppetfileEditor
     end
   end
 
+  # Abstraction of logging methods for PuppetfileEditor::CLI
+  #
+  # @api private
   class Logging
     def initialize
       @statuses = {
@@ -126,6 +136,5 @@ module PuppetfileEditor
     def mod_message(mod, indent)
       log("#{mod.name.ljust(indent)} => #{mod.message}", mod.status)
     end
-
   end
 end

data/lib/puppetfile_editor/module.rb

@@ -1,4 +1,5 @@
 module PuppetfileEditor
+  # Module class represents a puppet module in Puppetfile
   class Module
     attr_reader :type
     attr_reader :params
@@ -30,29 +31,29 @@ module PuppetfileEditor
 
     def set(param, newvalue, force = false)
       case @type
-        when :hg, :git
-          if !force && !([:branch, :ref, :changeset] & @params.keys).empty?
-            set_message("kept at (#{full_version})", :wont_upgrade)
-          elsif !%w[branch tag ref changeset].include? param
-            set_message("only 'branch', 'tag', 'ref', and 'changeset' 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.delete :changeset
-            @params[param.to_sym] = newvalue
-            calculate_indent
-          end
-        when :forge
-          if param == 'version'
-            @params[:version] = newvalue
-            set_message("successfully set #{param} to #{newvalue} for #{@name}.", :updated)
-          else
-            set_message("only 'version' is supported for forge modules.", :unsupported)
-          end
+      when :hg, :git
+        if !force && !([:branch, :ref, :changeset] & @params.keys).empty?
+          set_message("kept at (#{full_version})", :wont_upgrade)
+        elsif !%w[branch tag ref changeset].include? param
+          set_message("only 'branch', 'tag', 'ref', and 'changeset' are supported for '#{@type}' modules.", :unsupported)
         else
-          set_message("editing params for '#{@type}' modules is not supported.", :unsupported)
+          set_message("updated (#{full_version} to #{param}: #{newvalue}", :updated)
+          @params.delete :branch
+          @params.delete :tag
+          @params.delete :ref
+          @params.delete :changeset
+          @params[param.to_sym] = newvalue
+          calculate_indent
+        end
+      when :forge
+        if param == 'version'
+          @params[:version] = newvalue
+          set_message("successfully set #{param} to #{newvalue} for #{@name}.", :updated)
+        else
+          set_message("only 'version' is supported for forge modules.", :unsupported)
+        end
+      else
+        set_message("editing params for '#{@type}' modules is not supported.", :unsupported)
       end
     end
 
@@ -62,62 +63,62 @@ module PuppetfileEditor
         return
       end
       case @type
-        when :hg, :git
-          new = mod.params.reject { |param, _| param.eql? @type }
-          if !force && new.keys == [:tag] && !([:branch, :ref, :changeset] & @params.keys).empty?
-            set_message("kept at #{full_version}", :wont_upgrade)
-            return
-          end
-          if full_version == mod.full_version
-            set_message("versions match (#{full_version})", :matched)
-            return
-          else
-            set_message("updated (#{full_version} to #{mod.full_version})", :updated)
-          end
-          @params.delete_if { |param, _| [:branch, :tag, :ref, :changeset].include? param }
-          @params.merge!(new)
-          calculate_indent
-        when :forge
-          unless force
-            if mod.params.nil? || mod.params.is_a?(Symbol)
-              set_message("won't upgrade to #{mod.full_version}", :wont_upgrade)
-              return
-            end
-          end
-          if full_version == mod.full_version
-            set_message("versions match (#{full_version})", :matched)
+      when :hg, :git
+        new = mod.params.reject { |param, _| param.eql? @type }
+        if !force && new.keys == [:tag] && !([:branch, :ref, :changeset] & @params.keys).empty?
+          set_message("kept at #{full_version}", :wont_upgrade)
+          return
+        end
+        if full_version == mod.full_version
+          set_message("versions match (#{full_version})", :matched)
+          return
+        else
+          set_message("updated (#{full_version} to #{mod.full_version})", :updated)
+        end
+        @params.delete_if { |param, _| [:branch, :tag, :ref, :changeset].include? param }
+        @params.merge!(new)
+        calculate_indent
+      when :forge
+        unless force
+          if mod.params.nil? || mod.params.is_a?(Symbol)
+            set_message("won't upgrade to #{mod.full_version}", :wont_upgrade)
             return
-          else
-            set_message("updated (#{full_version} to #{mod.full_version})", :updated)
           end
-          @params = mod.params
+        end
+        if full_version == mod.full_version
+          set_message("versions match (#{full_version})", :matched)
+          return
         else
-          set_message('only git, forge, and hg modules are supported for merging', :skipped)
+          set_message("updated (#{full_version} to #{mod.full_version})", :updated)
+        end
+        @params = mod.params
+      else
+        set_message('only git, forge, and hg modules are supported for merging', :skipped)
       end
     end
 
     def dump
       output = []
       case @type
-        when :hg, :git
-          output.push "mod '#{full_title}'"
-          @params.each do |param_name, param_value|
-            value = if param_value == :latest
-              ':latest'
-            else
-              "'#{param_value}'"
-            end
-            param = "#{param_name}:".ljust(@indent)
-            output.push "    #{param} #{value}"
-          end
-        when :local
-          output.push("mod '#{full_title}', :local")
+      when :hg, :git
+        output.push "mod '#{full_title}'"
+        @params.each do |param_name, param_value|
+          value = if param_value == :latest
+                    ':latest'
+                  else
+                    "'#{param_value}'"
+                  end
+          param = "#{param_name}:".ljust(@indent)
+          output.push "    #{param} #{value}"
+        end
+      when :local
+        output.push("mod '#{full_title}', :local")
+      else
+        if @params.nil?
+          output.push("mod '#{full_title}'")
         else
-          if @params.nil?
-            output.push("mod '#{full_title}'")
-          else
-            output.push("mod '#{full_title}', '#{@params[:version]}'")
-          end
+          output.push("mod '#{full_title}', '#{@params[:version]}'")
+        end
       end
       output.join(",\n")
     end
@@ -129,11 +130,11 @@ module PuppetfileEditor
 
     def full_version
       case @type
-        when :hg, :git
-          @params.reject { |param, _| param.eql? @type }.map { |param, value| "#{param}: #{value}" }.sort.join(', ')
-        when :forge
-          return @params[:version] if @params.key? :version
-          nil
+      when :hg, :git
+        @params.reject { |param, _| param.eql? @type }.map { |param, value| "#{param}: #{value}" }.sort.join(', ')
+      when :forge
+        return @params[:version] if @params.key? :version
+        nil
       end
     end
 

data/lib/puppetfile_editor/puppetfile.rb

@@ -71,11 +71,9 @@ module PuppetfileEditor
     end
 
     def update_module(name, param, value)
-      if @modules.key? name
-        @modules[name].set(param, value, true)
-      else
-        raise StandardError, "Module #{name} does not exist in your Puppetfile"
-      end
+      raise StandardError, "Module #{name} does not exist in your Puppetfile" unless @modules.key? name
+
+      @modules[name].set(param, value, true)
     end
 
     def compare_with(pf)
@@ -108,6 +106,10 @@ module PuppetfileEditor
       @modules[mod.name] = mod
     end
 
+    def delete_module(name)
+      @modules.delete(name)
+    end
+
     def update_forge_url(url)
       raise StandardError, "Forge URL must be a String, but it is a #{url.class}" unless url.is_a? String
       @forge = url

data/lib/puppetfile_editor/version.rb

@@ -1,3 +1,3 @@
 module PuppetfileEditor
-  VERSION = '0.4.0'.freeze
+  VERSION = '0.5.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppetfile_editor
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Eugene Piven
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-07 00:00:00.000000000 Z
+date: 2017-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler