puppet-strings 2.4.0 → 2.5.0

data/spec/unit/puppet-strings/yard/code_objects/task_spec.rb

@@ -1,92 +0,0 @@
-require 'spec_helper'
-require 'puppet-strings/yard/code_objects/task'
-require 'puppet-strings/yard/parsers/json/task_statement'
-
-describe PuppetStrings::Yard::CodeObjects::Task do
-  let(:source) { <<-SOURCE
-{
-  "description": "Allows you to backup your database to local file.",
-  "input_method": "stdin",
-  "parameters": {
-    "database": {
-      "description": "Database to connect to",
-      "type": "Optional[String[1]]"
-    },
-    "user": {
-      "description": "The user",
-      "type": "Optional[String[1]]"
-    },
-    "password": {
-      "description": "The password",
-      "type": "Optional[String[1]]"
-    },
-     "sql": {
-      "description": "Path to file you want backup to",
-      "type": "String[1]"
-    }
-  }
-}
-  SOURCE
-  }
-  let(:json) { JSON.parse(source) }
-  let(:statement) { PuppetStrings::Yard::Parsers::JSON::TaskStatement.new(json, source, "test.json") }
-  subject { PuppetStrings::Yard::CodeObjects::Task.new(statement) }
-
-  describe '#type' do
-    it 'returns the correct type' do
-      expect(subject.type).to eq(:puppet_task)
-    end
-  end
-
-  describe '#source' do
-    it 'returns the source' do
-      expect(subject.source).to eq(source)
-    end
-  end
-
-  describe '#to_hash' do
-    let(:expected) do
-      {
-        :name => "test",
-        :supports_noop => false,
-        :docstring => {
-          :text=>"Allows you to backup your database to local file.",
-          :tags=> [
-            {
-              :name=>"database",
-              :tag_name=>"param",
-              :text=>"Database to connect to",
-              :types=> ["Optional[String[1]]"]
-            },
-            {
-              :name=>"user",
-              :tag_name=>"param",
-              :text=>"The user",
-              :types=> ["Optional[String[1]]"]
-            },
-            {
-              :name=>"password",
-              :tag_name=>"param",
-              :text=>"The password",
-              :types=> ["Optional[String[1]]"]
-            },
-            {
-              :name=>"sql",
-              :tag_name=>"param",
-              :text=>"Path to file you want backup to",
-              :types=>["String[1]"]
-            }
-          ]
-        },
-        :file => "test.json",
-        :input_method => "stdin",
-        :line => 0,
-        :source => "{\n  \"description\": \"Allows you to backup your database to local file.\",\n  \"input_method\": \"stdin\",\n  \"parameters\": {\n    \"database\": {\n      \"description\": \"Database to connect to\",\n      \"type\": \"Optional[String[1]]\"\n    },\n    \"user\": {\n      \"description\": \"The user\",\n      \"type\": \"Optional[String[1]]\"\n    },\n    \"password\": {\n      \"description\": \"The password\",\n      \"type\": \"Optional[String[1]]\"\n    },\n     \"sql\": {\n      \"description\": \"Path to file you want backup to\",\n      \"type\": \"String[1]\"\n    }\n  }\n}\n"
-      }
-    end
-
-    it 'returns the correct hash' do
-      expect(subject.to_hash).to eq(expected)
-    end
-  end
-end

data/spec/unit/puppet-strings/yard/handlers/json/task_handler_spec.rb

@@ -1,116 +0,0 @@
-require 'spec_helper'
-require 'puppet-strings/yard'
-
-describe PuppetStrings::Yard::Handlers::JSON::TaskHandler do
-  subject {
-    YARD::Parser::SourceParser.parse_string(source, :json)
-    YARD::Registry.all(:puppet_task)
-  }
-
-  describe 'parsing task metadata with a syntax error' do
-    let(:source) { <<-SOURCE
-{
-  "input_method": "stdin",
-  "parameters":
-    "database": {
-      "description": "Database to connect to",
-      "type": "Optional[String[1]]"
-    }
-  }
-}
-    SOURCE
-    }
-
-    it 'should log an error' do
-      expect{ subject }.to output(/\[error\]: Failed to parse \(stdin\):/).to_stdout_from_any_process
-      expect(subject.empty?).to eq(true)
-    end
-  end
-
-  describe 'parsing task metadata with a missing description' do
-    let(:source) { <<-SOURCE
-{
-  "input_method": "stdin",
-  "parameters": {
-    "database": {
-      "description": "Database to connect to",
-      "type": "Optional[String[1]]"
-    },
-    "user": {
-      "description": "The user",
-      "type": "Optional[String[1]]"
-    },
-    "password": {
-      "description": "The password",
-      "type": "Optional[String[1]]"
-    },
-     "sql": {
-      "description": "Path to file you want backup to",
-      "type": "String[1]"
-    }
-  }
-}
-    SOURCE
-    }
-
-    it 'should log a warning' do
-      expect{ subject }.to output(/\[warn\]: Missing a description for Puppet Task \(stdin\)/).to_stdout_from_any_process
-    end
-  end
-
-  describe 'parsing task metadata with a description' do
-    let(:source) { <<-SOURCE
-{
-  "description": "Allows you to backup your database to local file.",
-  "input_method": "stdin",
-  "parameters": {
-    "database": {
-      "description": "Database to connect to",
-      "type": "Optional[String[1]]"
-    },
-    "user": {
-      "description": "The user",
-      "type": "Optional[String[1]]"
-    },
-    "password": {
-      "description": "The password",
-      "type": "Optional[String[1]]"
-    },
-     "sql": {
-      "description": "Path to file you want backup to",
-      "type": "String[1]"
-    }
-  }
-}
-
-    SOURCE
-    }
-
-    it 'should register a task object' do
-      expect(subject.size).to eq(1)
-      object = subject.first
-      expect(object).to be_a(PuppetStrings::Yard::CodeObjects::Task)
-      expect(object.namespace).to eq(PuppetStrings::Yard::CodeObjects::Tasks.instance)
-    end
-  end
-
-  describe 'parsing task metadata with a missing parameter description' do
-    let(:source) { <<-SOURCE
-{
-  "description": "Allows you to backup your database to local file.",
-  "input_method": "stdin",
-  "parameters": {
-    "database": {
-      "type": "Optional[String[1]]"
-    }
-  }
-}
-    SOURCE
-    }
-
-    it 'should output a warning' do
-      expect{ subject }.to output(/\[warn\]: Missing description for param 'database' in Puppet Task \(stdin\)/).to_stdout_from_any_process
-    end
-  end
-
-end

data/spec/unit/puppet-strings/yard/handlers/puppet/class_handler_spec.rb

@@ -1,217 +0,0 @@
-require 'spec_helper'
-require 'puppet-strings/yard'
-
-describe PuppetStrings::Yard::Handlers::Puppet::ClassHandler do
-  subject {
-    YARD::Parser::SourceParser.parse_string(source, :puppet)
-    YARD::Registry.all(:puppet_class)
-  }
-
-  describe 'parsing source without a class definition' do
-    let(:source) { 'notice hi' }
-
-    it 'no classes should be in the registry' do
-      expect(subject.empty?).to eq(true)
-    end
-  end
-
-  describe 'parsing source with a syntax error' do
-    let(:source) { 'class foo{' }
-
-    it 'should log an error' do
-      expect{ subject }.to output(/\[error\]: Failed to parse \(stdin\): Syntax error at end of (file|input)/).to_stdout_from_any_process
-      expect(subject.empty?).to eq(true)
-    end
-  end
-
-  describe 'parsing a class with a missing docstring' do
-    let(:source) { 'class foo{}' }
-
-    it 'should log a warning' do
-      expect{ subject }.to output(/\[warn\]: Missing documentation for Puppet class 'foo' at \(stdin\):1\./).to_stdout_from_any_process
-    end
-  end
-
-  describe 'parsing a class with a docstring' do
-    let(:source) { <<-SOURCE
-# A simple foo class.
-# @param param1 First param.
-# @param param2 Second param.
-# @param param3 Third param.
-class foo(Integer $param1, $param2, String $param3 = hi) inherits foo::bar {
-  file { '/tmp/foo':
-    ensure => present
-  }
-}
-    SOURCE
-    }
-
-    it 'should register a class object' do
-      expect(subject.size).to eq(1)
-      object = subject.first
-      expect(object).to be_a(PuppetStrings::Yard::CodeObjects::Class)
-      expect(object.namespace).to eq(PuppetStrings::Yard::CodeObjects::Classes.instance)
-      expect(object.name).to eq(:foo)
-      expect(object.statement).not_to eq(nil)
-      expect(object.parameters).to eq([['param1', nil], ['param2', nil], ['param3', 'hi']])
-      expect(object.docstring).to eq('A simple foo class.')
-      expect(object.docstring.tags.size).to eq(4)
-      tags = object.docstring.tags(:param)
-      expect(tags.size).to eq(3)
-      expect(tags[0].name).to eq('param1')
-      expect(tags[0].text).to eq('First param.')
-      expect(tags[0].types).to eq(['Integer'])
-      expect(tags[1].name).to eq('param2')
-      expect(tags[1].text).to eq('Second param.')
-      expect(tags[1].types).to eq(['Any'])
-      expect(tags[2].name).to eq('param3')
-      expect(tags[2].text).to eq('Third param.')
-      expect(tags[2].types).to eq(['String'])
-      tags = object.docstring.tags(:api)
-      expect(tags.size).to eq(1)
-      expect(tags[0].text).to eq('public')
-    end
-  end
-
-  describe 'parsing a class with a missing parameter' do
-    let(:source) { <<-SOURCE
-# A simple foo class.
-# @param param1 First param.
-# @param param2 Second param.
-# @param param3 Third param.
-# @param param4 missing!
-class foo(Integer $param1, $param2, String $param3 = hi) inherits foo::bar {
-  file { '/tmp/foo':
-    ensure => present
-  }
-}
-    SOURCE
-    }
-
-    it 'should output a warning' do
-      expect{ subject }.to output(/\[warn\]: The @param tag for parameter 'param4' has no matching parameter at \(stdin\):6\./).to_stdout_from_any_process
-    end
-  end
-
-  describe 'parsing a class with a missing @param tag' do
-    let(:source) { <<-SOURCE
-# A simple foo class.
-# @param param1 First param.
-# @param param2 Second param.
-class foo(Integer $param1, $param2, String $param3 = hi) inherits foo::bar {
-  file { '/tmp/foo':
-    ensure => present
-  }
-}
-    SOURCE
-    }
-
-    it 'should output a warning' do
-      expect{ subject }.to output(/\[warn\]: Missing @param tag for parameter 'param3' near \(stdin\):4\./).to_stdout_from_any_process
-    end
-  end
-
-  describe 'parsing a class with a typed parameter that also has a @param tag type which matches' do
-    let(:source) { <<-SOURCE
-# A simple foo class.
-# @param [Integer] param1 First param.
-# @param param2 Second param.
-# @param param3 Third param.
-class foo(Integer $param1, $param2, String $param3 = hi) inherits foo::bar {
-  file { '/tmp/foo':
-    ensure => present
-  }
-}
-    SOURCE
-    }
-
-    it 'should respect the type that was documented' do
-      expect{ subject }.to output('').to_stdout_from_any_process
-      expect(subject.size).to eq(1)
-      tags = subject.first.tags(:param)
-      expect(tags.size).to eq(3)
-      expect(tags[0].types).to eq(['Integer'])
-    end
-  end
-
-  describe 'parsing a class with a typed parameter that also has a @param tag type which does not match' do
-    let(:source) { <<-SOURCE
-# A simple foo class.
-# @param [Boolean] param1 First param.
-# @param param2 Second param.
-# @param param3 Third param.
-class foo(Integer $param1, $param2, String $param3 = hi) inherits foo::bar {
-  file { '/tmp/foo':
-    ensure => present
-  }
-}
-    SOURCE
-    }
-
-    it 'should output a warning' do
-      expect{ subject }.to output(/\[warn\]: The type of the @param tag for parameter 'param1' does not match the parameter type specification near \(stdin\):5: ignoring in favor of parameter type information./).to_stdout_from_any_process
-    end
-  end
-
-  describe 'parsing a class with a untyped parameter that also has a @param tag type' do
-    let(:source) { <<-SOURCE
-# A simple foo class.
-# @param param1 First param.
-# @param [Boolean] param2 Second param.
-# @param param3 Third param.
-class foo(Integer $param1, $param2, String $param3 = hi) inherits foo::bar {
-  file { '/tmp/foo':
-    ensure => present
-  }
-}
-    SOURCE
-    }
-
-    it 'should respect the type that was documented' do
-      expect{ subject }.to output('').to_stdout_from_any_process
-      expect(subject.size).to eq(1)
-      tags = subject.first.tags(:param)
-      expect(tags.size).to eq(3)
-      expect(tags[1].types).to eq(['Boolean'])
-    end
-  end
-
-  describe 'parsing a class with a summary' do
-    context 'when the summary has fewer than 140 characters' do
-      let(:source) { <<-SOURCE
-  # A simple foo class.
-  # @summary A short summary.
-  class foo() {
-    file { '/tmp/foo':
-      ensure => present
-    }
-  }
-      SOURCE
-      }
-
-      it 'should parse the summary' do
-        expect{ subject }.to output('').to_stdout_from_any_process
-        expect(subject.size).to eq(1)
-        summary = subject.first.tags(:summary)
-        expect(summary.first.text).to eq('A short summary.')
-      end
-    end
-
-    context 'when the summary has more than 140 characters' do
-      let(:source) { <<-SOURCE
-  # A simple foo class.
-  # @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!!
-  class foo() {
-    file { '/tmp/foo':
-      ensure => present
-    }
-  }
-      SOURCE
-      }
-
-      it 'should log a warning' do
-        expect{ subject }.to output(/\[warn\]: The length of the summary for puppet_class 'foo' exceeds the recommended limit of 140 characters./).to_stdout_from_any_process
-      end
-    end
-  end
-end

data/spec/unit/puppet-strings/yard/handlers/puppet/data_type_alias_handler_spec.rb

@@ -1,65 +0,0 @@
-require 'spec_helper'
-require 'puppet-strings/yard'
-
-describe PuppetStrings::Yard::Handlers::Puppet::DataTypeAliasHandler, if: TEST_PUPPET_DATATYPES do
-  subject {
-    YARD::Parser::SourceParser.parse_string(source, :puppet)
-    YARD::Registry.all(:puppet_data_type_alias)
-  }
-
-  describe 'parsing source without a type alias definition' do
-    let(:source) { 'notice hi' }
-
-    it 'no aliases should be in the registry' do
-      expect(subject.empty?).to eq(true)
-    end
-  end
-
-  describe 'parsing source with a syntax error' do
-    let(:source) { 'type Testype =' }
-
-    it 'should log an error' do
-      expect{ subject }.to output(/\[error\]: Failed to parse \(stdin\): Syntax error at end of (file|input)/).to_stdout_from_any_process
-      expect(subject.empty?).to eq(true)
-    end
-  end
-
-  describe 'parsing a data type alias with a missing docstring' do
-    let(:source) { 'type Testype = String[1]' }
-
-    it 'should log a warning' do
-      expect{ subject }.to output(/\[warn\]: Missing documentation for Puppet type alias 'Testype' at \(stdin\):1\./).to_stdout_from_any_process
-    end
-  end
-
-  describe 'parsing a data type alias with a summary' do
-    context 'when the summary has fewer than 140 characters' do
-      let(:source) { <<-SOURCE
-  # A simple foo type.
-  # @summary A short summary.
-  type Testype = String[1]
-  SOURCE
-      }
-
-      it 'should parse the summary' do
-        expect{ subject }.to output('').to_stdout_from_any_process
-        expect(subject.size).to eq(1)
-        summary = subject.first.tags(:summary)
-        expect(summary.first.text).to eq('A short summary.')
-      end
-    end
-
-    context 'when the summary has more than 140 characters' do
-      let(:source) { <<-SOURCE
-  # A simple foo type.
-  # @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!!
-  type Testype = String[1]
-  SOURCE
-      }
-
-      it 'should log a warning' do
-        expect{ subject }.to output(/\[warn\]: The length of the summary for puppet_data_type_alias 'Testype' exceeds the recommended limit of 140 characters./).to_stdout_from_any_process
-      end
-    end
-  end
-end