rototiller 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5bac726b080a90b1a417f2dbbe519753651e0a09
-  data.tar.gz: 226f14f9d9527f807928b9f642a8dfe2190890ca
+SHA256:
+  metadata.gz: 428406284e02d3f3836b5039dacd64f7a51595f6923ff1cd08096446f782bfc2
+  data.tar.gz: 1d6a070369ffb77f474fe973a403478491c3188e223d70a064a0e80308fe5790
 SHA512:
-  metadata.gz: 47025a7eba9c59e1681fbdb270173478d42a9afa46d75053f1521c23231ef5b6813528300fc8a8d4353870120bc59e210a3983f1100750cd2e09518950e8aca9
-  data.tar.gz: 8afc54e03f69185564f16256da20ccba2e67910b01df2b57ebc3b7937eb4ca1c308af1245e7e065c16d742765a6f5279b4c0c5c7b054ece96941bca5493289e4
+  metadata.gz: 76c2d17e76d1284e2338fc77030b78bb3152affdb2d4f2259b4789f00d9c784d379bfcfa4686a1c0e0a38964ead56124f1bb662eb9895bf61902993ed6b020fc
+  data.tar.gz: b6f97b132f3f5b4f98c84c91dab4a0a40af6e89844eed5bf36945faae28933782b051d93a8c38b19c858fe544cc966188e0e3a3b0b47ac4c882251aff7862858

data/CONTRIBUTING.md

@@ -38,6 +38,24 @@
 * During the time that you are working on your patch the master Rototiller branch may have changed - you'll want to [rebase](http://git-scm.com/book/en/Git-Branching-Rebasing) before you submit your PR with `git rebase master`.  A successful rebase ensures that your patch will cleanly merge into Rototiller.
 * Submitted patches will be smoke tested through a series of acceptance level tests that ensures basic Rototiller functionality - the results of these tests will be evaluated by a Rototiller team member.  Failures associated with the submitted patch will result in the patch being rejected.
 
+## Testing
+
+* `bundle install`
+* run the unit tests
+  * this runs rspec on the local machine
+  * do not write tests that could mess with the local machine
+  * `bundle exec rake test:unit`
+* run the acceptance tests
+  * some of these could theoretically do weird stuff to the local system
+  * so we run these in a container
+  * a running docker server is required
+  * `docker login pcr-internal.puppet.net`
+  * `docker pull pcr-internal.puppet.net/slv/rototiller:latest`
+  * we'll  mirror the image to docker soon, probably, for your local testing, outside of Puppet.
+  * `bundle exec rake test:acceptance`
+
+  These tests all run in CI.  the unit tests are also run in the container to save time in the repeated bundle installs and rvm setup steps. You are welcome to use the container as well if you want to avoid the bundle install.  Just gem install rototiller (to make our own Rakefile _go_ and you can rake test:unit all day.
+
 ## Submitting Changes
 
 * Sign the [Contributor License Agreement](http://links.puppet.com/cla).

data/lib/rototiller/task/params.rb

@@ -12,12 +12,26 @@ module Rototiller
 
       attr_accessor :name
       attr_accessor :message
+      attr_accessor :parent_name
+      attr_accessor :parent_message
 
       # we must always have a message that can be aggregated via the parent params
       # @return [String] <empty string>
       def message
         return ''
       end
+
+      def parent_name=(name)
+        name.each_char do |char|
+          message = "You have defined an environment variable with an illegal character: #{char}"
+          raise ArgumentError.new(message) unless char =~ /[a-zA-Z]|\d|_/
+        end
+        @parent_name = name
+      end
+
+      def parent_message=(message)
+        @parent_message = message
+      end
     end
 
   end

data/lib/rototiller/task/params/command.rb

@@ -215,7 +215,9 @@ module Rototiller
       #   itself, env_vars, switches, options, arguments
       # TODO make private method? so that it will throw an error if yielded to?
       def message
-        return [@message,
+        return_message = @message
+        return_message += "\n" if @message && @message != ''
+        return [return_message,
                 @env_vars.messages,
                 @switches.messages,
                 @options.messages,

data/lib/rototiller/task/params/env_var.rb

@@ -33,7 +33,9 @@ module Rototiller
       # @return EnvVar object
       def initialize(args={}, &block)
         @parent_name = args[:parent_name]
+        @message ||= args[:parent_message]
         args.delete(:parent_name)
+        args.delete(:parent_message)
         block_given? ? (yield self) : send_hash_keys_as_methods_to_self(args)
 
         raise(ArgumentError, 'A name must be supplied to add_env') unless @name

data/lib/rototiller/task/params/option.rb

@@ -43,6 +43,15 @@ module Rototiller
         [@name.to_s, @arguments.to_s].compact.join(' ')
       end
 
+      # @return [String] formatted messages from all of Switch's pieces
+      #   itself, env_vars
+      # TODO make private method? so that it will throw an error if yielded to?
+      def message
+        return_message = [@message, @env_vars.messages, @arguments.messages].join ''
+        return_message += "\n" unless return_message == ''
+        return return_message
+      end
+
       # Does this param require the task to stop
       # Determined by the interactions between @name, @env_vars, @arguments
       # @return [true|nil] if this param requires a stop
@@ -51,13 +60,6 @@ module Rototiller
         return true unless @name
       end
 
-      # @return [String] formatted messages from all of Option's pieces
-      #   itself, env_vars, arguments
-      # TODO make private method? so that it will throw an error if yielded to?
-      def message
-        return [@message, @env_vars.messages, @arguments.messages].join('')
-      end
-
     end
   end
 end

data/lib/rototiller/task/params/switch.rb

@@ -21,6 +21,7 @@ module Rototiller
       def initialize(args={}, &block)
         # the env_vars that override the name
         @env_vars      = EnvCollection.new
+        @message ||= args[:parent_message]
         block_given? ? (yield self) : send_hash_keys_as_methods_to_self(args)
         @name ||= @env_vars.last
       end
@@ -41,7 +42,7 @@ module Rototiller
         #   but if this gets moved to a mixin, it might be more tolerable
         if block_given?
           # send in the name of this Param, so it can be used when no default is given to add_env
-          @env_vars.push(EnvVar.new({:parent_name => @name},&block))
+          @env_vars.push(EnvVar.new({:parent_name => @name, @parent_message => @message},&block))
         else
           #TODO: test this with array and non-array single hash
           args.each do |arg| # we can accept an array of hashes, each of which defines a param
@@ -49,6 +50,7 @@ module Rototiller
             raise ArgumentError.new(error_string) unless arg.is_a?(Hash)
             # send in the name of this Param, so it can be used when no default is given to add_env
             arg[:parent_name] = @name
+            arg[:parent_message] = @message
             @env_vars.push(EnvVar.new(arg))
           end
         end
@@ -66,7 +68,9 @@ module Rototiller
       #   itself, env_vars
       # TODO make private method? so that it will throw an error if yielded to?
       def message
-        return [@message, @env_vars.messages].join ''
+        return_message = [@message, @env_vars.messages].join ''
+        return_message += "\n" unless return_message == ''
+        return return_message
       end
 
       # The string representation of this Switch; the value sent by author, or overridden by any env_vars

data/lib/rototiller/task/rototiller_task.rb

@@ -105,7 +105,7 @@ module Rototiller
         print_messages
         stop_task?
         @commands.each do |command|
-          puts command if @verbose
+          puts command
 
           begin
             command.run

data/lib/rototiller/version.rb

@@ -1,5 +1,5 @@
 module Rototiller
   module Version
-    STRING = '1.0.1'
+    STRING = '1.0.2'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rototiller
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Puppet, Inc.
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-04 00:00:00.000000000 Z
+date: 2018-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -79,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Puppet Labs rake tool