puppet-strings 1.2.1 → 2.0.0

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

@@ -70,6 +70,7 @@ SOURCE
 Puppet::ResourceApi.register_type(
   name: 'database',
   docs: 'An example database server resource type.',
+  features: ['remote-resource'],
   attributes: {
     ensure: {
       type: 'Enum[present, absent, up, down]',
@@ -133,19 +134,19 @@ SOURCE
       expect(object.properties[1].docstring).to eq('What state the database should be in.')
       expect(object.properties[1].isnamevar).to eq(false)
       expect(object.properties[1].default).to eq('up')
-      expect(object.properties[1].values).to eq(['Enum[present, absent, up, down]'])
+      expect(object.properties[1].data_type).to eq('Enum[present, absent, up, down]')
       expect(object.properties[1].aliases).to eq({})
       expect(object.properties[2].name).to eq('file')
       expect(object.properties[2].docstring).to eq('The database file to use.')
       expect(object.properties[2].isnamevar).to eq(false)
       expect(object.properties[2].default).to be_nil
-      expect(object.properties[2].values).to eq(['String'])
+      expect(object.properties[2].data_type).to eq('String')
       expect(object.properties[2].aliases).to eq({})
       expect(object.properties[3].name).to eq('log_level')
       expect(object.properties[3].docstring).to eq('The log level to use.')
       expect(object.properties[3].isnamevar).to eq(false)
       expect(object.properties[3].default).to eq('warn')
-      expect(object.properties[3].values).to eq(['Enum[debug, warn, error]'])
+      expect(object.properties[3].data_type).to eq('Enum[debug, warn, error]')
       expect(object.properties[3].aliases).to eq({})
       expect(object.parameters.size).to eq(5)
       expect(object.parameters[0].name).to eq('dynamic_param')
@@ -156,25 +157,25 @@ SOURCE
       expect(object.parameters[1].docstring).to eq('The database server name.')
       expect(object.parameters[1].isnamevar).to eq(true)
       expect(object.parameters[1].default).to be_nil
-      expect(object.parameters[1].values).to eq(['String'])
+      expect(object.parameters[1].data_type).to eq('String')
       expect(object.parameters[1].aliases).to eq({})
       expect(object.parameters[2].name).to eq('encrypt')
       expect(object.parameters[2].docstring).to eq('Whether or not to encrypt the database.')
       expect(object.parameters[2].isnamevar).to eq(false)
       expect(object.parameters[2].default).to eq(false)
-      expect(object.parameters[2].values).to eq(["Boolean"])
+      expect(object.parameters[2].data_type).to eq("Boolean")
       expect(object.parameters[2].aliases).to eq({})
       expect(object.parameters[3].name).to eq('encryption_key')
       expect(object.parameters[3].docstring).to eq('The encryption key to use.')
       expect(object.parameters[3].isnamevar).to eq(false)
       expect(object.parameters[3].default).to be_nil
-      expect(object.parameters[3].values).to eq(["Optional[String]"])
+      expect(object.parameters[3].data_type).to eq("Optional[String]")
       expect(object.parameters[3].aliases).to eq({})
       expect(object.parameters[4].name).to eq('backup')
       expect(object.parameters[4].docstring).to eq('How often to backup the database.')
       expect(object.parameters[4].isnamevar).to eq(false)
       expect(object.parameters[4].default).to eq('never')
-      expect(object.parameters[4].values).to eq(["Enum[daily, monthly, never]"])
+      expect(object.parameters[4].data_type).to eq("Enum[daily, monthly, never]")
     end
   end
 

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

@@ -0,0 +1,70 @@
+require 'spec_helper'
+require 'puppet-strings/yard'
+
+describe PuppetStrings::Yard::Parsers::JSON::Parser do
+  subject { PuppetStrings::Yard::Parsers::JSON::Parser.new(source, file) }
+  let(:file) { 'test.json' }
+
+  describe 'initialization of the parser' do
+    let(:source) { 'notice hi' }
+
+    it 'should store the original source' do
+      expect(subject.source).to eq(source)
+    end
+
+    it 'should store the original file name' do
+      expect(subject.file).to eq(file)
+    end
+
+    it 'should have no relevant statements' do
+      subject.parse
+      expect(subject.enumerator.empty?).to be_truthy
+    end
+  end
+
+  describe 'parsing invalid JSON' do
+    let(:source) { <<SOURCE
+class foo {
+SOURCE
+    }
+
+    it 'should raise an exception' do
+      expect{ subject.parse }.to output(/\[error\]: Failed to parse test.json/).to_stdout_from_any_process
+    end
+  end
+
+
+  describe 'parsing puppet functions with return type in defintion', if: TEST_FUNCTION_RETURN_TYPE 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 parse the puppet function statement' do
+      subject.parse
+      expect(subject.enumerator.size).to eq(1)
+      statement = subject.enumerator.first
+      expect(statement).to be_instance_of(PuppetStrings::Yard::Parsers::JSON::TaskStatement)
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe PuppetStrings::Yard::Parsers::JSON::TaskStatement 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) }
+  subject { PuppetStrings::Yard::Parsers::JSON::TaskStatement.new(json, source, "test.json") }
+  describe '#comments' do
+    it 'returns docstring' do
+      expect(subject.comments).to eq "Allows you to backup your database to local file."
+    end
+  end
+  describe '#parameters' do
+    context 'with params' do
+      it 'returns params' do
+        expect(subject.parameters.size > 0).to be true
+      end
+    end
+    context 'no params' do
+      let(:source) { <<-SOURCE
+{
+  "description": "Allows you to backup your database to local file.",
+  "input_method": "stdin"
+}
+SOURCE
+      }
+      it 'returns an empty hash' do
+        expect(subject.parameters).to eq({})
+      end
+    end
+  end
+
+end

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

@@ -29,7 +29,7 @@ SOURCE
     }
 
     it 'should raise an exception' do
-      expect{ subject.parse }.to output(/\[error\]: Failed to parse test.pp: Syntax error at end of file/).to_stdout_from_any_process
+      expect{ subject.parse }.to output(/\[error\]: Failed to parse test.pp: Syntax error at end of (file|input)/).to_stdout_from_any_process
     end
   end
 

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

@@ -28,4 +28,21 @@ STR
       expect(subject.scrub_string(str)).to eq('this is a test string')
     end
   end
+
+  describe 'github_to_yard_links' do
+    it 'converts a link correctly' do
+      str = '<a href="#module-description">'
+      expect(subject.github_to_yard_links(str)).to eq('<a href="#label-Module+description">')
+    end
+
+    it 'leaves other links with hashes alone' do
+      str = '<a href="www.github.com/blah/document.html#module-description">'
+      expect(subject.github_to_yard_links(str)).to eq(str)
+    end
+
+    it 'leaves plain text alone' do
+      str = '<a href="#module-description"> module-description'
+      expect(subject.github_to_yard_links(str)).to eq('<a href="#label-Module+description"> module-description')
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-strings
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Puppet Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-01 00:00:00.000000000 Z
+date: 2018-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -55,7 +55,6 @@ files:
 - Gemfile
 - JSON.md
 - LICENSE
-- MAINTAINERS
 - README.md
 - Rakefile
 - codecov.yml
@@ -69,13 +68,19 @@ files:
 - lib/puppet-strings/markdown/functions.rb
 - lib/puppet-strings/markdown/puppet_class.rb
 - lib/puppet-strings/markdown/puppet_classes.rb
+- lib/puppet-strings/markdown/puppet_plan.rb
+- lib/puppet-strings/markdown/puppet_plans.rb
+- lib/puppet-strings/markdown/puppet_task.rb
+- lib/puppet-strings/markdown/puppet_tasks.rb
 - lib/puppet-strings/markdown/resource_type.rb
 - lib/puppet-strings/markdown/resource_types.rb
 - lib/puppet-strings/markdown/table_of_contents.rb
 - lib/puppet-strings/markdown/templates/classes_and_defines.erb
 - lib/puppet-strings/markdown/templates/function.erb
+- lib/puppet-strings/markdown/templates/puppet_task.erb
 - lib/puppet-strings/markdown/templates/resource_type.erb
 - lib/puppet-strings/markdown/templates/table_of_contents.erb
+- lib/puppet-strings/monkey_patches/display_object_command.rb
 - lib/puppet-strings/tasks.rb
 - lib/puppet-strings/tasks/generate.rb
 - lib/puppet-strings/tasks/gh_pages.rb
@@ -86,20 +91,27 @@ files:
 - lib/puppet-strings/yard/code_objects/defined_type.rb
 - lib/puppet-strings/yard/code_objects/function.rb
 - lib/puppet-strings/yard/code_objects/group.rb
+- lib/puppet-strings/yard/code_objects/plan.rb
 - lib/puppet-strings/yard/code_objects/provider.rb
+- lib/puppet-strings/yard/code_objects/task.rb
 - lib/puppet-strings/yard/code_objects/type.rb
 - lib/puppet-strings/yard/handlers.rb
 - lib/puppet-strings/yard/handlers/helpers.rb
+- lib/puppet-strings/yard/handlers/json/base.rb
+- lib/puppet-strings/yard/handlers/json/task_handler.rb
 - lib/puppet-strings/yard/handlers/puppet/base.rb
 - lib/puppet-strings/yard/handlers/puppet/class_handler.rb
 - lib/puppet-strings/yard/handlers/puppet/defined_type_handler.rb
 - lib/puppet-strings/yard/handlers/puppet/function_handler.rb
+- lib/puppet-strings/yard/handlers/puppet/plan_handler.rb
 - lib/puppet-strings/yard/handlers/ruby/base.rb
 - lib/puppet-strings/yard/handlers/ruby/function_handler.rb
 - lib/puppet-strings/yard/handlers/ruby/provider_handler.rb
 - lib/puppet-strings/yard/handlers/ruby/rsapi_handler.rb
 - lib/puppet-strings/yard/handlers/ruby/type_handler.rb
 - lib/puppet-strings/yard/parsers.rb
+- lib/puppet-strings/yard/parsers/json/parser.rb
+- lib/puppet-strings/yard/parsers/json/task_statement.rb
 - lib/puppet-strings/yard/parsers/puppet/parser.rb
 - lib/puppet-strings/yard/parsers/puppet/statement.rb
 - lib/puppet-strings/yard/tags.rb
@@ -111,7 +123,9 @@ files:
 - 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
+- lib/puppet-strings/yard/templates/default/fulldoc/html/full_list_puppet_plan.erb
 - lib/puppet-strings/yard/templates/default/fulldoc/html/full_list_puppet_provider.erb
+- lib/puppet-strings/yard/templates/default/fulldoc/html/full_list_puppet_task.erb
 - lib/puppet-strings/yard/templates/default/fulldoc/html/full_list_puppet_type.erb
 - lib/puppet-strings/yard/templates/default/fulldoc/html/setup.rb
 - lib/puppet-strings/yard/templates/default/layout/html/footer.erb
@@ -135,6 +149,12 @@ files:
 - lib/puppet-strings/yard/templates/default/puppet_function/html/setup.rb
 - lib/puppet-strings/yard/templates/default/puppet_function/html/source.erb
 - lib/puppet-strings/yard/templates/default/puppet_function/html/summary.erb
+- lib/puppet-strings/yard/templates/default/puppet_plan/html/box_info.erb
+- lib/puppet-strings/yard/templates/default/puppet_plan/html/header.erb
+- lib/puppet-strings/yard/templates/default/puppet_plan/html/overview.erb
+- lib/puppet-strings/yard/templates/default/puppet_plan/html/setup.rb
+- lib/puppet-strings/yard/templates/default/puppet_plan/html/source.erb
+- lib/puppet-strings/yard/templates/default/puppet_plan/html/summary.erb
 - lib/puppet-strings/yard/templates/default/puppet_provider/html/box_info.erb
 - lib/puppet-strings/yard/templates/default/puppet_provider/html/collection.erb
 - lib/puppet-strings/yard/templates/default/puppet_provider/html/features.erb
@@ -142,6 +162,13 @@ files:
 - lib/puppet-strings/yard/templates/default/puppet_provider/html/overview.erb
 - lib/puppet-strings/yard/templates/default/puppet_provider/html/setup.rb
 - lib/puppet-strings/yard/templates/default/puppet_provider/html/summary.erb
+- lib/puppet-strings/yard/templates/default/puppet_task/html/box_info.erb
+- lib/puppet-strings/yard/templates/default/puppet_task/html/header.erb
+- lib/puppet-strings/yard/templates/default/puppet_task/html/input.erb
+- lib/puppet-strings/yard/templates/default/puppet_task/html/overview.erb
+- lib/puppet-strings/yard/templates/default/puppet_task/html/parameters.erb
+- lib/puppet-strings/yard/templates/default/puppet_task/html/setup.rb
+- lib/puppet-strings/yard/templates/default/puppet_task/html/supports_noop.erb
 - lib/puppet-strings/yard/templates/default/puppet_type/html/box_info.erb
 - lib/puppet-strings/yard/templates/default/puppet_type/html/features.erb
 - lib/puppet-strings/yard/templates/default/puppet_type/html/header.erb
@@ -169,13 +196,17 @@ files:
 - spec/fixtures/acceptance/modules/test/manifests/triple_nested_classes.pp
 - spec/fixtures/acceptance/modules/test/metadata.json
 - spec/fixtures/unit/json/output.json
+- spec/fixtures/unit/json/output_with_plan.json
 - spec/fixtures/unit/json/output_without_puppet_function.json
 - spec/fixtures/unit/markdown/output.md
+- spec/fixtures/unit/markdown/output_with_plan.md
 - spec/spec_helper.rb
 - spec/spec_helper_acceptance.rb
 - spec/unit/puppet-strings/json_spec.rb
 - spec/unit/puppet-strings/markdown/base_spec.rb
 - spec/unit/puppet-strings/markdown_spec.rb
+- spec/unit/puppet-strings/yard/code_objects/task_spec.rb
+- spec/unit/puppet-strings/yard/handlers/json/task_handler_spec.rb
 - spec/unit/puppet-strings/yard/handlers/puppet/class_handler_spec.rb
 - spec/unit/puppet-strings/yard/handlers/puppet/defined_type_handler_spec.rb
 - spec/unit/puppet-strings/yard/handlers/puppet/function_handler_spec.rb
@@ -183,6 +214,8 @@ files:
 - spec/unit/puppet-strings/yard/handlers/ruby/provider_handler_spec.rb
 - spec/unit/puppet-strings/yard/handlers/ruby/rsapi_handler_spec.rb
 - spec/unit/puppet-strings/yard/handlers/ruby/type_handler_spec.rb
+- spec/unit/puppet-strings/yard/parsers/json/parser_spec.rb
+- spec/unit/puppet-strings/yard/parsers/json/task_statement_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
@@ -197,14 +230,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.1.9
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements:
-- puppet, >= 3.7.0
+- puppet, >= 4.0.0
 rubyforge_project: 
 rubygems_version: 2.6.8
 signing_key: 

data/MAINTAINERS

@@ -1,17 +0,0 @@
-{
-  "version": 1,
-  "file_format": "This MAINTAINERS file format is described at http://pup.pt/maintainers",
-  "issues": "https://tickets.puppetlabs.com/browse/PDOC",
-  "people": [
-    {
-      "github": "whopper",
-      "email": "whopper@puppet.com",
-      "name": "Will Hopper"
-    },
-    {
-      "github": "scotje",
-      "email": "jesse@puppet.com",
-      "name": "Jesse Scott"
-    }
-  ]
-}