puppet-strings/lib/puppet_x/puppetlabs/strings/yard/handlers/base.rb

require 'puppet_x/puppetlabs/strings/yard/core_ext/yard'

class PuppetX::PuppetLabs::Strings::YARD::Handlers::Base < YARD::Handlers::Base
  # Easy access to Pops model objects for handler matching.
  include Puppet::Pops::Model
  # Easy access to custom code objects from which documentation is generated.
  include PuppetX::PuppetLabs::Strings::YARD::CodeObjects

  def self.handles?(statement)
    handlers.any? {|h| h == statement.type}
  end

end
(PDOC-25) Fix mangled puppet namespaces Prior to this commit, puppet namespaces would be totally mangled when processed by YARD since YARD is looking for Ruby namespaces where the first letter of each segment must be uppercase. In order to fix this, patch the relevant regular expression constants in YARD so that they will accept segments that begin with uppercase and lowercase letters. An upstream pull request has been accepted into YARD to add another regex constant which is necessary to complete this patch. However until the next version of the YARD gem is released, we must include a temporary hack to fix the problematic method in question (as it is not yet using the added variable). Once the new version is released, the conditional statement in code_ext/yard.rb can be removed entirely and all we will need to do is patch the two regex constants. 2015-02-27 00:03:21 +00:00			`require 'puppet_x/puppetlabs/strings/yard/core_ext/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			`class PuppetX::PuppetLabs::Strings::YARD::Handlers::Base < YARD::Handlers::Base`
(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			`# Easy access to Pops model objects for handler matching.`
			`include Puppet::Pops::Model`
			`# Easy access to custom code objects from which documentation is generated.`
(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			`include PuppetX::PuppetLabs::Strings::YARD::CodeObjects`
Add simple handlers Add a base handler class and a handler that processes `HostClassDefinition` instances. 2014-05-23 06:45:08 +00:00
(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			`def self.handles?(statement)`
			`handlers.any? {\|h\| h == statement.type}`
Add simple handlers Add a base handler class and a handler that processes `HostClassDefinition` instances. 2014-05-23 06:45:08 +00:00			`end`
(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
Add simple handlers Add a base handler class and a handler that processes `HostClassDefinition` instances. 2014-05-23 06:45:08 +00:00			`end`