puppet-strings 2.3.0 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a70d1194ec3d0f50cc7924ce43b3d996b08db414a31639d38135c90863b3163
-  data.tar.gz: 821fef3a3e096caa7a3a51024db23e18658baba2b25bf4f503a750952e8e3657
+  metadata.gz: d8e021936451f50bd6d90032ebb46117245b1be028c0e717a02bb54ceb682194
+  data.tar.gz: 2ae779863af3e9882d2d5c6a0609cfb4fd994a2683429a9f62a271762e58828d
 SHA512:
-  metadata.gz: 457119ac6a325f6c4f62923a6180b05d346b0e2d2b7e560b4cddfeda51f345284e98421abb46a68a2a3c0bd62933300394866d91247d69ef2b154667ffd91df3
-  data.tar.gz: db555eb951d97aa8ac62396693c9c9d317f4e361b4b9dd405d9b7d21d6ccda9f89beb70f292053e6f0440e02b6cf9fb2b8e5f9defb209a6920a7597337128834
+  metadata.gz: 4795376753de54d5157d4b040781e9b2c322a777efa62b0400968ec895cb6a5aba32c20d19c374f9a5ab4c06b6fdcf6256f9c722684b356f1b64907194487f22
+  data.tar.gz: 564f9d8ec0b7db59f46c882358c3126ad7d98f9629c4760f96b496f94563af69f69dcc0560fcb6465c88c0104aca6dd8d1df2342740b626a3c3e9fc80f3b90a3

data/CHANGELOG.md

@@ -3,6 +3,15 @@
 All significant changes to this repo will be summarized in this file.
 
 
+## [v2.3.1](https://github.com/puppetlabs/puppet-strings/tree/v2.3.1) (2019-09-23)
+
+[Full Changelog](https://github.com/puppetlabs/puppet-strings/compare/v2.3.0...v2.3.1)
+
+Fixed
+
+- \(maint\) Use parameters method instead of json\['parameters'\] [\#211](https://github.com/puppetlabs/puppet-strings/pull/211) ([lucywyman](https://github.com/lucywyman))
+- \(PDOC-285\) Fix data\_type\_handler for errors and numbers [\#209](https://github.com/puppetlabs/puppet-strings/pull/209) ([glennsarti](https://github.com/glennsarti))
+
 ## [v2.3.0](https://github.com/puppetlabs/puppet-strings/tree/v2.3.0) (2019-07-17)
 
 [Full Changelog](https://github.com/puppetlabs/puppet-strings/compare/v2.2.0...v2.3.0)

data/CODEOWNERS

@@ -0,0 +1 @@
+* @puppet-strings-maintainers

data/lib/puppet-strings/version.rb

@@ -1,3 +1,3 @@
 module PuppetStrings
-  VERSION = '2.3.0'.freeze
+  VERSION = '2.3.1'.freeze
 end

data/lib/puppet-strings/yard/code_objects/task.rb

@@ -43,7 +43,7 @@ class PuppetStrings::Yard::CodeObjects::Task < PuppetStrings::Yard::CodeObjects:
 
   def parameters
     parameters = []
-    statement.json['parameters'].each do |name,props|
+    statement.parameters.each do |name,props|
       parameters.push({ name: name.to_s,
                         tag_name: 'param',
                         text: props['description'] || "",

data/lib/puppet-strings/yard/handlers/ruby/data_type_handler.rb

@@ -14,7 +14,7 @@ class PuppetStrings::Yard::Handlers::Ruby::DataTypeHandler < PuppetStrings::Yard
     return unless ruby_module_name == 'Puppet::DataTypes' || ruby_module_name == 'DataTypes' # rubocop:disable Style/MultipleComparison This reads better
     object = get_datatype_yard_object(get_name(statement, 'Puppet::DataTypes.create_type'))
 
-    actual_params = extract_params_for_data_type # populate_data_type_data(object)
+    actual_params = extract_params_for_data_type
 
     # Mark the data type as public if it doesn't already have an api tag
     object.add_tag YARD::Tags::Tag.new(:api, 'public') unless object.has_tag? :api
@@ -65,7 +65,13 @@ class PuppetStrings::Yard::Handlers::Ruby::DataTypeHandler < PuppetStrings::Yard
         interface_string = node_as_string(parameters[0])
         next unless interface_string
         # Ref - https://github.com/puppetlabs/puppet/blob/ba4d1a1aba0095d3c70b98fea5c67434a4876a61/lib/puppet/datatypes.rb#L159
-        parsed_interface = Puppet::Pops::Parser::EvaluatingParser.new.parse_string("{ #{interface_string} }").body
+        parsed_interface = nil
+        begin
+          parsed_interface = Puppet::Pops::Parser::EvaluatingParser.new.parse_string("{ #{interface_string} }").body
+        rescue Puppet::Error => e
+          log.warn "Invalid datatype definition at #{statement.file}:#{statement.line}: #{e.basic_message}"
+          next
+        end
         next unless parsed_interface
 
         # Now that we parsed the Puppet code (as a string) into a LiteralHash PCore type (Puppet AST),
@@ -146,6 +152,10 @@ class PuppetStrings::Yard::Handlers::Ruby::DataTypeHandler < PuppetStrings::Yard
       o.value
     end
 
+    def literal_UnaryMinusExpression(o) # rubocop:disable Naming/UncommunicativeMethodParamName
+      -1 * literal(o.expr)
+    end
+
     def literal_LiteralBoolean(o) # rubocop:disable Naming/UncommunicativeMethodParamName
       o.value
     end

data/spec/spec_helper_acceptance.rb

@@ -25,7 +25,7 @@ else
     options[:port] = node_config.dig('ssh', 'port') unless node_config.dig('ssh', 'port').nil?
     options[:keys] = node_config.dig('ssh', 'private-key') unless node_config.dig('ssh', 'private-key').nil?
     options[:password] = node_config.dig('ssh', 'password') unless node_config.dig('ssh', 'password').nil?
-    options[:verify_host_key] = Net::SSH::Verifiers::Null.new unless node_config.dig('ssh', 'host-key-check').nil?
+    options[:verify_host_key] = Net::SSH::Verifiers::Never.new unless node_config.dig('ssh', 'host-key-check').nil?
     host = if ENV['TARGET_HOST'].include?(':')
              ENV['TARGET_HOST'].split(':').first
            else

data/spec/unit/puppet-strings/yard/handlers/ruby/data_type_handler_spec.rb

@@ -189,6 +189,83 @@ SOURCE
     end
   end
 
+  testcases = [
+    { :value => '-1', :expected => -1 },
+    { :value => '0', :expected => 0 },
+    { :value => '10', :expected => 10 },
+    { :value => '0777', :expected => 511 },
+    { :value => '0xFF', :expected => 255 },
+    { :value => '0.1', :expected => 0.1 },
+    { :value => '31.415e-1', :expected => 3.1415 },
+    { :value => '0.31415e1', :expected => 3.1415 }
+  ].each do |testcase|
+    describe "parsing a valid data type definition with numeric default #{testcase[:value]}" do
+      let(:source) { <<-SOURCE
+# An example Puppet Data Type in Ruby.
+# @param num1 A numeric parameter
+Puppet::DataTypes.create_type('RubyDataType') do
+  interface <<-PUPPET
+    attributes => {
+      num1 => { type => Numeric, value => #{testcase[:value]} },
+    }
+    PUPPET
+end
+SOURCE
+      }
+
+      it 'should register a data type object' do
+        expect(subject.size).to eq(1)
+        object = subject.first
+        expect(object).to be_a(PuppetStrings::Yard::CodeObjects::DataType)
+        expect(object.parameters.size).to eq(1)
+        expect(object.parameters[0]).to eq(['num1', testcase[:expected]])
+      end
+    end
+  end
+
+  describe 'parsing a invalid data type definition' do
+    let(:source) { <<-SOURCE
+# The msg attribute is missing a comma.
+#
+# @param msg A message parameter5.
+# @param arg1 Optional String parameter5. Defaults to 'param'.
+Puppet::DataTypes.create_type('RubyDataType') do
+  interface <<-PUPPET
+    attributes => {
+      msg   => Variant[Numeric, String[1,2]]
+      arg1  => { type => Optional[String[1]], value => "param" }
+    }
+    PUPPET
+end
+SOURCE
+    }
+
+    it 'should register a partial data type object' do
+      expect(subject.size).to eq(1)
+      object = subject.first
+      expect(object).to be_a(PuppetStrings::Yard::CodeObjects::DataType)
+      expect(object.namespace).to eq(PuppetStrings::Yard::CodeObjects::DataTypes.instance)
+      expect(object.name).to eq(:RubyDataType)
+      expect(object.docstring).to eq('The msg attribute is missing a comma.')
+      # The attributes will be missing therefore only one tag
+      expect(object.docstring.tags.size).to eq(1)
+      tags = object.docstring.tags(:api)
+      expect(tags.size).to eq(1)
+      expect(tags[0].text).to eq('public')
+
+      # Check that the param tags are removed
+      tags = object.docstring.tags(:param)
+      expect(tags.size).to eq(0)
+
+      # Check for default values
+      expect(object.parameters.size).to eq(0)
+    end
+
+    it 'should log a warning' do
+      expect{ subject }.to output(/\[warn\]: Invalid datatype definition at (.+):[0-9]+: Syntax error at 'arg1'/).to_stdout_from_any_process
+    end
+  end
+
   describe 'parsing a data type with a summary' do
     context 'when the summary has fewer than 140 characters' do
       let(:source) { <<-SOURCE

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-strings
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.3.1
 platform: ruby
 authors:
 - Puppet Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-17 00:00:00.000000000 Z
+date: 2019-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -50,6 +50,7 @@ extra_rdoc_files:
 - README.md
 files:
 - CHANGELOG.md
+- CODEOWNERS
 - COMMITTERS.md
 - CONTRIBUTING.md
 - Gemfile
@@ -281,7 +282,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - puppet, >= 4.0.0
-rubygems_version: 3.0.4
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Puppet documentation via YARD