puppet-strings 0.99.0 → 1.0.0

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

@@ -55,6 +55,23 @@ SOURCE
     end
   end
 
+  describe 'parsing a type with a docstring which uses ruby `%Q` notation' do
+    let(:source) { <<-'SOURCE'
+Puppet::Type.newtype(:database) do
+  test = 'hello world!'
+  desc %Q{This is a multi-line
+  doc in %Q with #{test}}
+end
+SOURCE
+    }
+
+    it 'should strip the `%Q{}` and render the interpolation expression literally' do
+      expect(subject.size).to eq(1)
+      object = subject.first
+      expect(object.docstring).to eq("This is a multi-line\ndoc in %Q with \#{test}")
+    end
+  end
+
   describe 'parsing a type definition' do
     let(:source) { <<-SOURCE
 # @!puppet.type.param [value1, value2] dynamic_param Documentation for a dynamic parameter.
@@ -62,6 +79,11 @@ SOURCE
 Puppet::Type.newtype(:database) do
   desc 'An example database server resource type.'
   feature :encryption, 'The provider supports encryption.', methods: [:encrypt]
+
+  feature :magic,
+    'The feature docstring should have
+    whitespace and newlines stripped out.'
+
   ensurable do
     desc 'What state the database should be in.'
     defaultvalues
@@ -167,9 +189,11 @@ SOURCE
       expect(object.parameters[4].isnamevar).to eq(false)
       expect(object.parameters[4].default).to eq('never')
       expect(object.parameters[4].values).to eq(%w(daily monthly never))
-      expect(object.features.size).to eq(1)
+      expect(object.features.size).to eq(2)
       expect(object.features[0].name).to eq('encryption')
       expect(object.features[0].docstring).to eq('The provider supports encryption.')
+      expect(object.features[1].name).to eq('magic')
+      expect(object.features[1].docstring).to eq('The feature docstring should have whitespace and newlines stripped out.')
     end
   end
 

data/spec/unit/puppet-strings/yard/parsers/puppet/parser_spec.rb

@@ -168,4 +168,42 @@ SOURCE
       expect(statement.parameters[2].value).to eq('hi')
     end
   end
+
+  describe 'parsing puppet functions with return type in defintion', if: TEST_FUNCTION_RETURN_TYPE do
+      let(:source) { <<SOURCE
+  # A simple foo function.
+  # @return Returns a string
+  function foo() >> String {
+    notice world
+  }
+SOURCE
+      }
+
+    it 'should parse the puppet function statement' do
+      subject.parse
+      expect(subject.enumerator.size).to eq(1)
+      statement = subject.enumerator.first
+      expect(statement).to be_a(PuppetStrings::Yard::Parsers::Puppet::FunctionStatement)
+      expect(statement.type).to eq('String')
+    end
+  end
+
+  describe 'parsing puppet functions with complex return types in defintion', if: TEST_FUNCTION_RETURN_TYPE do
+      let(:source) { <<SOURCE
+  # A simple foo function.
+  # @return Returns a struct with a hash including one key which must be an integer between 1 and 10.
+  function foo() >> Struct[{'a' => Integer[1, 10]}] {
+    notice world
+  }
+SOURCE
+      }
+
+    it 'should parse the puppet function statement' do
+      subject.parse
+      expect(subject.enumerator.size).to eq(1)
+      statement = subject.enumerator.first
+      expect(statement).to be_a(PuppetStrings::Yard::Parsers::Puppet::FunctionStatement)
+      expect(statement.type).to eq("Struct\[{'a' => Integer[1, 10]}\]")
+    end
+  end
 end

data/spec/unit/puppet-strings/yard/util_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+require 'puppet-strings/yard'
+
+describe PuppetStrings::Yard::Util do
+  subject {PuppetStrings::Yard::Util}
+
+  describe 'scrub_string' do
+    it 'should remove `%Q` and its brackets from a string ' do
+      str = "%Q{this is a test string}"
+      expect(subject.scrub_string(str)).to eq('this is a test string')
+    end
+
+    it 'should remove `%q` and its brackets from a string' do
+      str = "%q{this is a test string}"
+      expect(subject.scrub_string(str)).to eq('this is a test string')
+    end
+
+    it 'should not affect newlines when %Q notation is used' do
+      str = <<-STR
+%Q{this is
+a test string}
+STR
+      expect(subject.scrub_string(str)).to eq("this is\na test string")
+    end
+
+    it 'should not affect a string which does not use %Q notation' do
+      str = "this is a test string"
+      expect(subject.scrub_string(str)).to eq('this is a test string')
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-strings
 version: !ruby/object:Gem::Version
-  version: 0.99.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Puppet Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-10 00:00:00.000000000 Z
+date: 2016-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -73,6 +73,7 @@ files:
 - lib/puppet-strings/yard/tags/overload_tag.rb
 - lib/puppet-strings/yard/tags/parameter_directive.rb
 - lib/puppet-strings/yard/tags/property_directive.rb
+- lib/puppet-strings/yard/templates/default/fulldoc/html/css/common.css
 - lib/puppet-strings/yard/templates/default/fulldoc/html/full_list_puppet_class.erb
 - lib/puppet-strings/yard/templates/default/fulldoc/html/full_list_puppet_defined_type.erb
 - lib/puppet-strings/yard/templates/default/fulldoc/html/full_list_puppet_function.erb
@@ -110,6 +111,7 @@ files:
 - lib/puppet-strings/yard/templates/default/puppet_type/html/setup.rb
 - lib/puppet-strings/yard/templates/default/tags/html/puppet_overload.erb
 - lib/puppet-strings/yard/templates/default/tags/setup.rb
+- lib/puppet-strings/yard/util.rb
 - lib/puppet/application/strings.rb
 - lib/puppet/face/strings.rb
 - lib/puppet/feature/rgen.rb
@@ -137,6 +139,7 @@ files:
 - spec/unit/puppet-strings/yard/handlers/ruby/provider_handler_spec.rb
 - spec/unit/puppet-strings/yard/handlers/ruby/type_handler_spec.rb
 - spec/unit/puppet-strings/yard/parsers/puppet/parser_spec.rb
+- spec/unit/puppet-strings/yard/util_spec.rb
 homepage: https://github.com/puppetlabs/puppet-strings
 licenses:
 - Apache-2.0