kienan
/
puppet-strings
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
puppet-strings/lib/puppet_x/puppetlabs/strings.rb

62 lines
2.5 KiB
Ruby
Raw Normal View History

(PDOC-3) Relocate plugin configuration The plugin.rb file really only did configuration of components that were already loaded. By relocating to the strings.rb file, it provides a central place for all of the loading and configuration of the strings components.
2014-09-30 21:21:20 +00:00
require 'puppet'
require 'puppet/pops'
require 'puppet/util/docs'
require 'yard'
(PDOC-3) Add puppetlabs directory In order to keep with conventions around directory structure, add a puppetlabs directory and rename modules accordingly.
2014-09-16 16:07:59 +00:00
(PDOC-26) Rename Puppetx to PuppetX Due to the changes in PUP-3900 which renamed Puppetx to PuppetX and puppetx to puppet_x, strings was failing since the namespace had not been updated in strings. In order to be compatible with this change, update strings by renaming the namespace to match. In order to ensure strings is still compatible with earlier versions of puppet that don't include the namespace change, declare our own PuppetX module. This way, if it is an older version and the namespace is called Puppetx, the necessary PuppetX namespace will be created.
2015-02-03 23:06:30 +00:00
module PuppetX
end
(PDOC-3) Add puppetlabs directory In order to keep with conventions around directory structure, add a puppetlabs directory and rename modules accordingly.
2014-09-16 16:07:59 +00:00
# Nothing to see here except forward declarations.
(PDOC-26) Rename Puppetx to PuppetX Due to the changes in PUP-3900 which renamed Puppetx to PuppetX and puppetx to puppet_x, strings was failing since the namespace had not been updated in strings. In order to be compatible with this change, update strings by renaming the namespace to match. In order to ensure strings is still compatible with earlier versions of puppet that don't include the namespace change, declare our own PuppetX module. This way, if it is an older version and the namespace is called Puppetx, the necessary PuppetX namespace will be created.
2015-02-03 23:06:30 +00:00
module PuppetX::PuppetLabs
(PDOC-3) Add puppetlabs directory In order to keep with conventions around directory structure, add a puppetlabs directory and rename modules accordingly.
2014-09-16 16:07:59 +00:00
module Strings
(PDOC-3) Relocate plugin configuration The plugin.rb file really only did configuration of components that were already loaded. By relocating to the strings.rb file, it provides a central place for all of the loading and configuration of the strings components.
2014-09-30 21:21:20 +00:00
# This submodule contains bits that operate on the Pops module produced by
# the Future parser.
module Pops
(PDOC-26) Rename Puppetx to PuppetX Due to the changes in PUP-3900 which renamed Puppetx to PuppetX and puppetx to puppet_x, strings was failing since the namespace had not been updated in strings. In order to be compatible with this change, update strings by renaming the namespace to match. In order to ensure strings is still compatible with earlier versions of puppet that don't include the namespace change, declare our own PuppetX module. This way, if it is an older version and the namespace is called Puppetx, the necessary PuppetX namespace will be created.
2015-02-03 23:06:30 +00:00
require 'puppet_x/puppetlabs/strings/pops/yard_statement'
require 'puppet_x/puppetlabs/strings/pops/yard_transformer'
(PDOC-3) Relocate plugin configuration The plugin.rb file really only did configuration of components that were already loaded. By relocating to the strings.rb file, it provides a central place for all of the loading and configuration of the strings components.
2014-09-30 21:21:20 +00:00
end
(PDOC-3) Add puppetlabs directory In order to keep with conventions around directory structure, add a puppetlabs directory and rename modules accordingly.
2014-09-16 16:07:59 +00:00
# This submodule contains bits that interface with the YARD plugin system.
module YARD
(PDOC-26) Rename Puppetx to PuppetX Due to the changes in PUP-3900 which renamed Puppetx to PuppetX and puppetx to puppet_x, strings was failing since the namespace had not been updated in strings. In order to be compatible with this change, update strings by renaming the namespace to match. In order to ensure strings is still compatible with earlier versions of puppet that don't include the namespace change, declare our own PuppetX module. This way, if it is an older version and the namespace is called Puppetx, the necessary PuppetX namespace will be created.
2015-02-03 23:06:30 +00:00
require 'puppet_x/puppetlabs/strings/yard/monkey_patches'
require 'puppet_x/puppetlabs/strings/yard/parser'
(PDOC-3) Switch to one line class declarations Prior to this commit, many of the classes in this project were declared in two lines. The first line would put them in the context of the module they belonged to, and the second line would declare the class and deal with inheritance. In order to make the code more readable and to allow require statements to be moved to the top level, turn all class declarations into one line statements.
2014-09-29 22:49:05 +00:00
(PDOC-35) Add a directive for puppet parameters * Print yard documentation statistics for providers * Define a directive which takes a type and a name
2015-08-10 17:16:26 +00:00
module Tags
require 'puppet_x/puppetlabs/strings/yard/tags/directives'
end
(PDOC-3) Move requires to top level scope Prior to this commit, the requires for the puppetx portion of this project were dealt with in each individual file. In order to make the code more readable and the requires more clear, move them all into the strings file.
2014-09-30 20:34:57 +00:00
# This submodule contains code objects which are used to represent relevant
# aspects of puppet code in YARD's Registry
(PDOC-3) Switch to one line class declarations Prior to this commit, many of the classes in this project were declared in two lines. The first line would put them in the context of the module they belonged to, and the second line would declare the class and deal with inheritance. In order to make the code more readable and to allow require statements to be moved to the top level, turn all class declarations into one line statements.
2014-09-29 22:49:05 +00:00
module CodeObjects
(PDOC-26) Rename Puppetx to PuppetX Due to the changes in PUP-3900 which renamed Puppetx to PuppetX and puppetx to puppet_x, strings was failing since the namespace had not been updated in strings. In order to be compatible with this change, update strings by renaming the namespace to match. In order to ensure strings is still compatible with earlier versions of puppet that don't include the namespace change, declare our own PuppetX module. This way, if it is an older version and the namespace is called Puppetx, the necessary PuppetX namespace will be created.
2015-02-03 23:06:30 +00:00
require 'puppet_x/puppetlabs/strings/yard/code_objects/puppet_namespace_object'
require 'puppet_x/puppetlabs/strings/yard/code_objects/defined_type_object'
require 'puppet_x/puppetlabs/strings/yard/code_objects/host_class_object'
(PDOC-35) First pass at documenting providers Adding a provider page and menu * Add categories to html search bar * Require provider handler and object classes * Fetch provider code objects from registry * Add function to generate the provider list * Fetch providers from registry in monkey patches * Add provider templates * Add provider code object * Add provider handler * Add erb file to populate the provider list * Don't emit type information for providers in html * Add tests for provider handler Refactor heredoc: * Remove heredoc annotations * Move heredoc functions into a heredoc helper * Add heredoc helper class
2015-07-31 21:59:15 +00:00
require 'puppet_x/puppetlabs/strings/yard/code_objects/provider_object'
(PDOC-3) Move requires to top level scope Prior to this commit, the requires for the puppetx portion of this project were dealt with in each individual file. In order to make the code more readable and the requires more clear, move them all into the strings file.
2014-09-30 20:34:57 +00:00
end
# This submodule contains handlers which are used to extract relevant data about
# puppet code from the ASTs produced by the Ruby and Puppet parsers
module Handlers
# This utility library contains some tools for working with Puppet docstrings
(PDOC-26) Rename Puppetx to PuppetX Due to the changes in PUP-3900 which renamed Puppetx to PuppetX and puppetx to puppet_x, strings was failing since the namespace had not been updated in strings. In order to be compatible with this change, update strings by renaming the namespace to match. In order to ensure strings is still compatible with earlier versions of puppet that don't include the namespace change, declare our own PuppetX module. This way, if it is an older version and the namespace is called Puppetx, the necessary PuppetX namespace will be created.
2015-02-03 23:06:30 +00:00
require 'puppet_x/puppetlabs/strings/yard/handlers/base'
require 'puppet_x/puppetlabs/strings/yard/handlers/defined_type_handler'
require 'puppet_x/puppetlabs/strings/yard/handlers/host_class_handler'
require 'puppet_x/puppetlabs/strings/yard/handlers/puppet_3x_function_handler'
require 'puppet_x/puppetlabs/strings/yard/handlers/puppet_4x_function_handler'
(PDOC-35) First pass at documenting providers Adding a provider page and menu * Add categories to html search bar * Require provider handler and object classes * Fetch provider code objects from registry * Add function to generate the provider list * Fetch providers from registry in monkey patches * Add provider templates * Add provider code object * Add provider handler * Add erb file to populate the provider list * Don't emit type information for providers in html * Add tests for provider handler Refactor heredoc: * Remove heredoc annotations * Move heredoc functions into a heredoc helper * Add heredoc helper class
2015-07-31 21:59:15 +00:00
require 'puppet_x/puppetlabs/strings/yard/handlers/provider_handler'
(PDOC-3) Switch to one line class declarations Prior to this commit, many of the classes in this project were declared in two lines. The first line would put them in the context of the module they belonged to, and the second line would declare the class and deal with inheritance. In order to make the code more readable and to allow require statements to be moved to the top level, turn all class declarations into one line statements.
2014-09-29 22:49:05 +00:00
end
(PDOC-3) Add puppetlabs directory In order to keep with conventions around directory structure, add a puppetlabs directory and rename modules accordingly.
2014-09-16 16:07:59 +00:00
(PDOC-3) Relocate plugin configuration The plugin.rb file really only did configuration of components that were already loaded. By relocating to the strings.rb file, it provides a central place for all of the loading and configuration of the strings components.
2014-09-30 21:21:20 +00:00
::YARD::Parser::SourceParser.register_parser_type(:puppet,
(PDOC-26) Rename Puppetx to PuppetX Due to the changes in PUP-3900 which renamed Puppetx to PuppetX and puppetx to puppet_x, strings was failing since the namespace had not been updated in strings. In order to be compatible with this change, update strings by renaming the namespace to match. In order to ensure strings is still compatible with earlier versions of puppet that don't include the namespace change, declare our own PuppetX module. This way, if it is an older version and the namespace is called Puppetx, the necessary PuppetX namespace will be created.
2015-02-03 23:06:30 +00:00
PuppetX::PuppetLabs::Strings::YARD::PuppetParser,
(PDOC-3) Relocate plugin configuration The plugin.rb file really only did configuration of components that were already loaded. By relocating to the strings.rb file, it provides a central place for all of the loading and configuration of the strings components.
2014-09-30 21:21:20 +00:00
['pp'])
::YARD::Handlers::Processor.register_handler_namespace(:puppet,
(PDOC-26) Rename Puppetx to PuppetX Due to the changes in PUP-3900 which renamed Puppetx to PuppetX and puppetx to puppet_x, strings was failing since the namespace had not been updated in strings. In order to be compatible with this change, update strings by renaming the namespace to match. In order to ensure strings is still compatible with earlier versions of puppet that don't include the namespace change, declare our own PuppetX module. This way, if it is an older version and the namespace is called Puppetx, the necessary PuppetX namespace will be created.
2015-02-03 23:06:30 +00:00
PuppetX::PuppetLabs::Strings::YARD::Handlers)
(PDOC-3) Relocate plugin configuration The plugin.rb file really only did configuration of components that were already loaded. By relocating to the strings.rb file, it provides a central place for all of the loading and configuration of the strings components.
2014-09-30 21:21:20 +00:00
# FIXME: Might not be the best idea to have the template code on the Ruby
# LOAD_PATH as the contents of this directory really aren't library code.
::YARD::Templates::Engine.register_template_path(
File.join(File.dirname(__FILE__), 'strings', 'yard', 'templates'))
(PDOC-3) Add puppetlabs directory In order to keep with conventions around directory structure, add a puppetlabs directory and rename modules accordingly.
2014-09-16 16:07:59 +00:00
end
end
end