puppet-strings 2.2.0 → 2.3.0

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

@@ -20,7 +20,7 @@ describe PuppetStrings::Yard::Handlers::Ruby::FunctionHandler do
       let(:source) { <<-SOURCE
 Puppet::Parser::Functions.newfunction(:foo) do |*args|
 end
-SOURCE
+      SOURCE
       }
 
       it 'should log a warning' do
@@ -38,7 +38,7 @@ An example 3.x function.
 DOC
 ) do |*args|
 end
-SOURCE
+      SOURCE
       }
 
       it 'should register a function object' do
@@ -82,7 +82,7 @@ DOC
 ) do |*args|
   end
 end
-SOURCE
+      SOURCE
       }
 
       it 'should register a function object' do
@@ -122,7 +122,7 @@ An example 3.x function.
 @param second The second parameter.
 DOC
 end
-SOURCE
+      SOURCE
       }
 
       it 'should log a warning' do
@@ -136,7 +136,7 @@ SOURCE
       let(:source) { <<-SOURCE
 Puppet::Functions.create_function(:foo) do
 end
-SOURCE
+      SOURCE
       }
 
       it 'should log a warning' do
@@ -149,7 +149,7 @@ SOURCE
 # An example 4.x function.
 Puppet::Functions.create_function(:foo) do
 end
-SOURCE
+      SOURCE
       }
 
       it 'should register a function object' do
@@ -179,7 +179,7 @@ Puppet::Functions.create_function(:foo) do
   def foo(param1, param2, param3 = nil)
   end
 end
-SOURCE
+      SOURCE
       }
 
       it 'should register a function object' do
@@ -231,7 +231,7 @@ Puppet::Functions.create_function(:foo) do
   def foo(param1, param2, param3 = nil)
   end
 end
-SOURCE
+      SOURCE
       }
 
       it 'should register a function object without any overload tags' do
@@ -285,7 +285,7 @@ Puppet::Functions.create_function(:foo) do
     "Bar"
   end
 end
-SOURCE
+      SOURCE
       }
 
       it 'does not throw an error with no @return' do
@@ -316,7 +316,7 @@ Puppet::Functions.create_function(:foo) do
     repeated_param 'String',  :param4
   end
 end
-SOURCE
+      SOURCE
       }
 
       it 'should register a function object with the expected parameters' do
@@ -365,7 +365,7 @@ Puppet::Functions.create_function(:foo) do
     optional_repeated_param 'String',  :param
   end
 end
-SOURCE
+      SOURCE
       }
 
       it 'should register a function object with the expected parameters' do
@@ -507,7 +507,7 @@ Puppet::Functions.create_function(:foo) do
     'lol'
   end
 end
-SOURCE
+    SOURCE
     }
 
     it 'should register a function object with overload tags' do
@@ -567,6 +567,23 @@ SOURCE
     end
   end
 
+  describe 'parsing a function with a namespaced name' do
+    let(:source) { <<-SOURCE
+# An example 4.x function.
+Puppet::Functions.create_function(:'foo::bar::baz') do
+  # @return [Undef]
+  dispatch :foo do
+  end
+end
+    SOURCE
+    }
+
+    it 'should output the name correctly as a symbol' do
+      expect(subject.size).to eq(1)
+      expect(subject.first.name).to eq(:'foo::bar::baz')
+    end
+  end
+
   describe 'parsing a function with a missing parameter' do
     let(:source) { <<-SOURCE
 # An example 4.x function.
@@ -576,7 +593,7 @@ Puppet::Functions.create_function(:foo) do
   dispatch :foo do
   end
 end
-SOURCE
+    SOURCE
     }
 
     it 'should output a warning' do
@@ -593,7 +610,7 @@ Puppet::Functions.create_function(:foo) do
     param 'String', :param1
   end
 end
-SOURCE
+    SOURCE
     }
 
     it 'should output a warning' do
@@ -611,7 +628,7 @@ Puppet::Functions.create_function(:foo) do
     param 'String', :param1
   end
 end
-SOURCE
+    SOURCE
     }
 
     it 'should output a warning' do
@@ -628,7 +645,7 @@ Puppet::Functions.create_function(:foo) do
     param 'String', :param1
   end
 end
-SOURCE
+    SOURCE
     }
 
     it 'should output a warning' do
@@ -645,7 +662,7 @@ Puppet::Functions.create_function(:foo) do
   dispatch :foo do
   end
 end
-SOURCE
+    SOURCE
     }
 
     it 'should output a warning' do
@@ -698,7 +715,7 @@ Puppet::Functions.create_function(:foo) do
   dispatch :foo do
   end
 end
-SOURCE
+      SOURCE
       }
 
       it 'should parse the summary' do
@@ -718,7 +735,7 @@ Puppet::Functions.create_function(:foo) do
   dispatch :foo do
   end
 end
-SOURCE
+      SOURCE
       }
 
       it 'should log a warning' do

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

@@ -19,7 +19,7 @@ describe PuppetStrings::Yard::Handlers::Ruby::ProviderHandler do
     let(:source) { <<-SOURCE
 Puppet::Type.type(:custom).provide :linux do
 end
-SOURCE
+    SOURCE
     }
 
     it 'should log a warning' do
@@ -32,7 +32,7 @@ SOURCE
 Puppet::Type.type(:custom).provide :linux do
   @doc = 123
 end
-SOURCE
+    SOURCE
     }
 
     it 'should log an error' do
@@ -45,7 +45,7 @@ SOURCE
 Puppet::Type.type(:custom).provide :linux do
   @doc = 'An example provider on Linux.'
 end
-SOURCE
+    SOURCE
     }
 
     it 'should correctly detect the docstring' do
@@ -62,7 +62,7 @@ Puppet::Type.type(:custom).provide :linux do
   desc %Q{This is a multi-line
   doc in %Q with #{test}}
 end
-SOURCE
+    SOURCE
     }
 
     it 'should strip the `%Q{}` and render the interpolation expression literally' do
@@ -84,7 +84,7 @@ Puppet::Type.type(:custom).provide :linux do
   has_feature :some_other_feature
   commands foo: '/usr/bin/foo'
 end
-SOURCE
+    SOURCE
     }
 
     it 'should register a provider object' do
@@ -106,13 +106,32 @@ SOURCE
     end
   end
 
+  describe 'parsing a provider definition with a string based name' do
+    let(:source) { <<-SOURCE
+Puppet::Type.type(:'custom').provide :'linux' do
+  desc 'An example provider on Linux.'
+end
+    SOURCE
+    }
+
+    it 'should register a provider object' do
+      expect(subject.size).to eq(1)
+      object = subject.first
+      expect(object).to be_a(PuppetStrings::Yard::CodeObjects::Provider)
+      expect(object.namespace).to eq(PuppetStrings::Yard::CodeObjects::Providers.instance('custom'))
+      expect(object.name).to eq(:linux)
+      expect(object.type_name).to eq('custom')
+      expect(object.docstring).to eq('An example provider on Linux.')
+    end
+  end
+
   describe 'parsing a provider with a summary' do
     context 'when the summary has fewer than 140 characters' do
       let(:source) { <<-SOURCE
 Puppet::Type.type(:custom).provide :linux do
   @doc = '@summary A short summary.'
 end
-SOURCE
+      SOURCE
       }
 
       it 'should parse the summary' do
@@ -128,7 +147,7 @@ SOURCE
 Puppet::Type.type(:custom).provide :linux do
   @doc = '@summary A short summary that is WAY TOO LONG. AHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHH this is not what a summary is for! It should be fewer than 140 characters!!'
 end
-SOURCE
+      SOURCE
       }
 
       it 'should log a warning' do

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

@@ -20,7 +20,7 @@ describe PuppetStrings::Yard::Handlers::Ruby::RsapiHandler do
 Puppet::ResourceApi.register_type(
   name: 'database'
 )
-SOURCE
+    SOURCE
     }
 
     it 'should log a warning' do
@@ -34,7 +34,7 @@ Puppet::ResourceApi.register_type(
   name: 'database',
   docs: 'An example database server resource type.',
 )
-SOURCE
+    SOURCE
     }
 
     it 'should correctly detect the docstring' do
@@ -53,7 +53,7 @@ Puppet::ResourceApi.register_type(
   docs: %Q{This is a multi-line
 doc in %Q with #{test}},
 )
-SOURCE
+    SOURCE
     }
 
     it 'should strip the `%Q{}` and render the interpolation expression literally' do
@@ -110,7 +110,7 @@ Puppet::ResourceApi.register_type(
     },
   },
 )
-SOURCE
+    SOURCE
     }
 
     it 'should register a type object' do
@@ -186,7 +186,7 @@ Puppet::ResourceApi.register_type(
   name: 'database',
   docs: '@summary A short summary.',
 )
-SOURCE
+      SOURCE
       }
 
       it 'should parse the summary' do
@@ -203,7 +203,7 @@ Puppet::ResourceApi.register_type(
   name: 'database',
   docs: '@summary A short summary that is WAY TOO LONG. AHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHH this is not what a summary is for! It should be fewer than 140 characters!!',
 )
-SOURCE
+      SOURCE
       }
 
       it 'should log a warning' do
@@ -224,7 +224,7 @@ Puppet::ResourceApi.register_type(
     }
   ]
 )
-SOURCE
+    SOURCE
     }
 
     it 'should not emit a warning' do

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

@@ -19,7 +19,7 @@ describe PuppetStrings::Yard::Handlers::Ruby::TypeHandler do
     let(:source) { <<-SOURCE
 Puppet::Type.newtype(:database) do
 end
-SOURCE
+    SOURCE
     }
 
     it 'should log a warning' do
@@ -32,7 +32,7 @@ SOURCE
 Puppet::Type.newtype(:database) do
   @doc = 123
 end
-SOURCE
+    SOURCE
     }
 
     it 'should log an error' do
@@ -45,7 +45,7 @@ SOURCE
 Puppet::Type.newtype(:database) do
   @doc = 'An example database server resource type.'
 end
-SOURCE
+    SOURCE
     }
 
     it 'should correctly detect the docstring' do
@@ -62,7 +62,7 @@ Puppet::Type.newtype(:database) do
   desc %Q{This is a multi-line
   doc in %Q with #{test}}
 end
-SOURCE
+    SOURCE
     }
 
     it 'should strip the `%Q{}` and render the interpolation expression literally' do
@@ -82,7 +82,7 @@ Puppet::Type.newtype(:database) do
     defaultto false
   end
 end
-SOURCE
+    SOURCE
     }
 
     it 'should correctly detect the required_feature' do
@@ -150,7 +150,7 @@ Puppet::Type.newtype(:database) do
     defaultto 'warn'
   end
 end
-SOURCE
+    SOURCE
     }
 
     it 'should register a type object' do
@@ -223,13 +223,29 @@ SOURCE
     end
   end
 
+  describe 'parsing a valid type with string based name' do
+    let(:source) { <<-SOURCE
+Puppet::Type.newtype(:'database') do
+  desc 'An example database server resource type.'
+  ensurable
+end
+    SOURCE
+    }
+
+    it 'should register a type object with default ensure values' do
+      expect(subject.size).to eq(1)
+      object = subject.first
+      expect(object.name).to eq(:database)
+    end
+  end
+
   describe 'parsing an ensurable type with default ensure values' do
     let(:source) { <<-SOURCE
 Puppet::Type.newtype(:database) do
   desc 'An example database server resource type.'
   ensurable
 end
-SOURCE
+    SOURCE
     }
 
     it 'should register a type object with default ensure values' do
@@ -250,7 +266,7 @@ Puppet::Type.newtype(:database) do
     desc 'The database server name.'
   end
 end
-SOURCE
+    SOURCE
     }
 
     it 'should register a type object with the "name" parameter as the namevar' do
@@ -268,7 +284,7 @@ SOURCE
 Puppet::Type.newtype(:database) do
   @doc = '@summary A short summary.'
 end
-SOURCE
+      SOURCE
       }
 
       it 'should parse the summary' do
@@ -284,7 +300,7 @@ SOURCE
 Puppet::Type.newtype(:database) do
   @doc = '@summary A short summary that is WAY TOO LONG. AHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHH this is not what a summary is for! It should be fewer than 140 characters!!'
 end
-SOURCE
+      SOURCE
       }
 
       it 'should log a warning' do

data/spec/unit/puppet-strings/yard/parsers/json/task_statement_spec.rb

@@ -24,7 +24,7 @@ describe PuppetStrings::Yard::Parsers::JSON::TaskStatement do
     }
   }
 }
-SOURCE
+  SOURCE
   }
   let(:json) { JSON.parse(source) }
   subject { PuppetStrings::Yard::Parsers::JSON::TaskStatement.new(json, source, "test.json") }
@@ -45,7 +45,7 @@ SOURCE
   "description": "Allows you to backup your database to local file.",
   "input_method": "stdin"
 }
-SOURCE
+      SOURCE
       }
       it 'returns an empty hash' do
         expect(subject.parameters).to eq({})