(PDOC-3) Use require instead of require_relative
Prior to this commit, the puppet strings project was using require_relative to include other classes and modules. Due to some ambiguity and the fact that the strings project shares some naming conventions with YARD, the use of require_relative sometimes made it unclear what was being included and where it was coming from. Now require is being used and although this requires the full path, it makes it very clear where things are coming from.
This commit is contained in:
parent
4c53f049e1
commit
df648a246f
|
@ -1,4 +0,0 @@
|
||||||
require 'puppet/util/feature'
|
|
||||||
|
|
||||||
# Support require_relative under Ruby 1.8.7.
|
|
||||||
Puppet.features.add(:require_relative, :libs => ['backports/1.9.1/kernel/require_relative'])
|
|
|
@ -1,7 +1,7 @@
|
||||||
require 'ostruct'
|
require 'ostruct'
|
||||||
require 'puppet/pops'
|
require 'puppet/pops'
|
||||||
|
|
||||||
require_relative '../../strings'
|
require 'puppetx/puppetlabs/strings'
|
||||||
|
|
||||||
module Puppetx::PuppetLabs::Strings::Pops
|
module Puppetx::PuppetLabs::Strings::Pops
|
||||||
# An adapter class that conforms a Pops model instance + adapters to the
|
# An adapter class that conforms a Pops model instance + adapters to the
|
||||||
|
|
|
@ -1,7 +1,6 @@
|
||||||
require 'puppet/pops'
|
require 'puppet/pops'
|
||||||
|
require 'puppetx/puppetlabs/strings'
|
||||||
require_relative '../../strings'
|
require 'puppetx/puppetlabs/strings/pops/yard_statement'
|
||||||
require_relative 'yard_statement'
|
|
||||||
|
|
||||||
module Puppetx::PuppetLabs::Strings::Pops
|
module Puppetx::PuppetLabs::Strings::Pops
|
||||||
# Loosely based on the TreeDumper classes in Pops::Model. The responsibility of
|
# Loosely based on the TreeDumper classes in Pops::Model. The responsibility of
|
||||||
|
|
|
@ -1,3 +1,3 @@
|
||||||
require_relative 'code_objects/puppet_namespace_object'
|
require 'puppetx/puppetlabs/strings/yard/code_objects/puppet_namespace_object'
|
||||||
require_relative 'code_objects/defined_type_object'
|
require 'puppetx/puppetlabs/strings/yard/code_objects/defined_type_object'
|
||||||
require_relative 'code_objects/host_class_object'
|
require 'puppetx/puppetlabs/strings/yard/code_objects/host_class_object'
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
require 'puppet/pops'
|
require 'puppet/pops'
|
||||||
|
|
||||||
require_relative 'puppet_namespace_object'
|
require 'puppetx/puppetlabs/strings/yard/code_objects/puppet_namespace_object'
|
||||||
|
|
||||||
module Puppetx::PuppetLabs::Strings::YARD::CodeObjects
|
module Puppetx::PuppetLabs::Strings::YARD::CodeObjects
|
||||||
class DefinedTypeObject < PuppetNamespaceObject
|
class DefinedTypeObject < PuppetNamespaceObject
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
require_relative 'defined_type_object'
|
require 'puppetx/puppetlabs/strings/yard/code_objects/defined_type_object'
|
||||||
|
|
||||||
module Puppetx::PuppetLabs::Strings::YARD::CodeObjects
|
module Puppetx::PuppetLabs::Strings::YARD::CodeObjects
|
||||||
class HostClassObject < DefinedTypeObject
|
class HostClassObject < DefinedTypeObject
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
require 'yard'
|
require 'yard'
|
||||||
|
require 'puppetx/puppetlabs/strings'
|
||||||
require_relative '../../../strings'
|
|
||||||
|
|
||||||
module Puppetx::PuppetLabs::Strings::YARD::CodeObjects
|
module Puppetx::PuppetLabs::Strings::YARD::CodeObjects
|
||||||
class PuppetNamespaceObject < YARD::CodeObjects::NamespaceObject
|
class PuppetNamespaceObject < YARD::CodeObjects::NamespaceObject
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
require_relative 'handlers/base'
|
require 'puppetx/puppetlabs/strings/yard/handlers/base'
|
||||||
require_relative 'handlers/defined_type_handler'
|
require 'puppetx/puppetlabs/strings/yard/handlers/defined_type_handler'
|
||||||
require_relative 'handlers/host_class_handler'
|
require 'puppetx/puppetlabs/strings/yard/handlers/host_class_handler'
|
||||||
|
|
||||||
require_relative 'handlers/puppet_3x_function_handler'
|
require 'puppetx/puppetlabs/strings/yard/handlers/puppet_3x_function_handler'
|
||||||
require_relative 'handlers/puppet_4x_function_handler'
|
require 'puppetx/puppetlabs/strings/yard/handlers/puppet_4x_function_handler'
|
||||||
|
|
|
@ -1,8 +1,8 @@
|
||||||
require 'yard'
|
require 'yard'
|
||||||
require 'puppet/pops'
|
require 'puppet/pops'
|
||||||
|
|
||||||
require_relative '../../../strings'
|
require 'puppetx/puppetlabs/strings'
|
||||||
require_relative '../code_objects'
|
require 'puppetx/puppetlabs/strings/yard/code_objects'
|
||||||
|
|
||||||
module Puppetx::PuppetLabs::Strings::YARD::Handlers
|
module Puppetx::PuppetLabs::Strings::YARD::Handlers
|
||||||
class Base < YARD::Handlers::Base
|
class Base < YARD::Handlers::Base
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
require_relative 'base'
|
require 'puppetx/puppetlabs/strings/yard/handlers/base'
|
||||||
|
|
||||||
module Puppetx::PuppetLabs::Strings::YARD::Handlers
|
module Puppetx::PuppetLabs::Strings::YARD::Handlers
|
||||||
class DefinedTypeHandler < Base
|
class DefinedTypeHandler < Base
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
require_relative 'base'
|
require 'puppetx/puppetlabs/strings/yard/handlers/base'
|
||||||
|
|
||||||
module Puppetx::PuppetLabs::Strings::YARD::Handlers
|
module Puppetx::PuppetLabs::Strings::YARD::Handlers
|
||||||
class HostClassHandler < Base
|
class HostClassHandler < Base
|
||||||
|
|
|
@ -1,7 +1,6 @@
|
||||||
# This utility library contains some tools for working with Puppet docstrings.
|
# This utility library contains some tools for working with Puppet docstrings.
|
||||||
require 'puppet/util/docs'
|
require 'puppet/util/docs'
|
||||||
|
require 'puppetx/puppetlabs/strings/yard/code_objects'
|
||||||
require_relative '../code_objects'
|
|
||||||
|
|
||||||
module Puppetx::PuppetLabs::Strings::YARD::Handlers
|
module Puppetx::PuppetLabs::Strings::YARD::Handlers
|
||||||
class Puppet3xFunctionHandler < YARD::Handlers::Ruby::Base
|
class Puppet3xFunctionHandler < YARD::Handlers::Ruby::Base
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
require_relative '../code_objects'
|
require 'puppetx/puppetlabs/strings/yard/code_objects'
|
||||||
|
|
||||||
module Puppetx::PuppetLabs::Strings::YARD::Handlers
|
module Puppetx::PuppetLabs::Strings::YARD::Handlers
|
||||||
# Handles `dispatch` calls within a future parser function declaration. For
|
# Handles `dispatch` calls within a future parser function declaration. For
|
||||||
|
|
|
@ -1,8 +1,8 @@
|
||||||
require 'yard'
|
require 'yard'
|
||||||
require 'puppet/pops'
|
require 'puppet/pops'
|
||||||
|
|
||||||
require_relative '../../strings'
|
require 'puppetx/puppetlabs/strings'
|
||||||
require_relative '../pops/yard_transformer'
|
require 'puppetx/puppetlabs/strings//pops/yard_transformer'
|
||||||
|
|
||||||
module Puppetx::PuppetLabs::Strings::YARD
|
module Puppetx::PuppetLabs::Strings::YARD
|
||||||
class PuppetParser < YARD::Parser::Base
|
class PuppetParser < YARD::Parser::Base
|
||||||
|
|
|
@ -1,13 +1,7 @@
|
||||||
# TODO: Decide if supporting 1.8.7 is really worth it.
|
|
||||||
if RUBY_VERSION < '1.9'
|
|
||||||
require 'backports/1.9.1/kernel/require_relative'
|
|
||||||
end
|
|
||||||
|
|
||||||
require 'puppet'
|
require 'puppet'
|
||||||
|
require 'puppetx/puppetlabs/strings/yard/monkey_patches'
|
||||||
require_relative 'monkey_patches'
|
require 'puppetx/puppetlabs/strings/yard/parser'
|
||||||
require_relative 'parser'
|
require 'puppetx/puppetlabs/strings/yard/handlers'
|
||||||
require_relative 'handlers'
|
|
||||||
|
|
||||||
YARD::Parser::SourceParser.register_parser_type(:puppet,
|
YARD::Parser::SourceParser.register_parser_type(:puppet,
|
||||||
Puppetx::PuppetLabs::Strings::YARD::PuppetParser,
|
Puppetx::PuppetLabs::Strings::YARD::PuppetParser,
|
||||||
|
|
Loading…
Reference in New Issue