From df648a246f96f4145f148033b85f5dd5d5788294 Mon Sep 17 00:00:00 2001 From: Hailee Kenney Date: Tue, 23 Sep 2014 11:27:27 -0700 Subject: [PATCH] (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. --- lib/puppet/feature/require_relative.rb | 4 ---- .../puppetlabs/strings/pops/yard_statement.rb | 2 +- .../puppetlabs/strings/pops/yard_transformer.rb | 5 ++--- lib/puppetx/puppetlabs/strings/yard/code_objects.rb | 6 +++--- .../strings/yard/code_objects/defined_type_object.rb | 2 +- .../strings/yard/code_objects/host_class_object.rb | 2 +- .../yard/code_objects/puppet_namespace_object.rb | 3 +-- lib/puppetx/puppetlabs/strings/yard/handlers.rb | 10 +++++----- lib/puppetx/puppetlabs/strings/yard/handlers/base.rb | 4 ++-- .../strings/yard/handlers/defined_type_handler.rb | 2 +- .../strings/yard/handlers/host_class_handler.rb | 2 +- .../yard/handlers/puppet_3x_function_handler.rb | 3 +-- .../yard/handlers/puppet_4x_function_handler.rb | 2 +- lib/puppetx/puppetlabs/strings/yard/parser.rb | 4 ++-- lib/puppetx/puppetlabs/strings/yard/plugin.rb | 12 +++--------- 15 files changed, 25 insertions(+), 38 deletions(-) delete mode 100644 lib/puppet/feature/require_relative.rb diff --git a/lib/puppet/feature/require_relative.rb b/lib/puppet/feature/require_relative.rb deleted file mode 100644 index 2a677f0..0000000 --- a/lib/puppet/feature/require_relative.rb +++ /dev/null @@ -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']) diff --git a/lib/puppetx/puppetlabs/strings/pops/yard_statement.rb b/lib/puppetx/puppetlabs/strings/pops/yard_statement.rb index 317ea4b..ac2fe4c 100644 --- a/lib/puppetx/puppetlabs/strings/pops/yard_statement.rb +++ b/lib/puppetx/puppetlabs/strings/pops/yard_statement.rb @@ -1,7 +1,7 @@ require 'ostruct' require 'puppet/pops' -require_relative '../../strings' +require 'puppetx/puppetlabs/strings' module Puppetx::PuppetLabs::Strings::Pops # An adapter class that conforms a Pops model instance + adapters to the diff --git a/lib/puppetx/puppetlabs/strings/pops/yard_transformer.rb b/lib/puppetx/puppetlabs/strings/pops/yard_transformer.rb index 5d1d82a..3cb57cb 100644 --- a/lib/puppetx/puppetlabs/strings/pops/yard_transformer.rb +++ b/lib/puppetx/puppetlabs/strings/pops/yard_transformer.rb @@ -1,7 +1,6 @@ require 'puppet/pops' - -require_relative '../../strings' -require_relative 'yard_statement' +require 'puppetx/puppetlabs/strings' +require 'puppetx/puppetlabs/strings/pops/yard_statement' module Puppetx::PuppetLabs::Strings::Pops # Loosely based on the TreeDumper classes in Pops::Model. The responsibility of diff --git a/lib/puppetx/puppetlabs/strings/yard/code_objects.rb b/lib/puppetx/puppetlabs/strings/yard/code_objects.rb index b87b4ad..b483541 100644 --- a/lib/puppetx/puppetlabs/strings/yard/code_objects.rb +++ b/lib/puppetx/puppetlabs/strings/yard/code_objects.rb @@ -1,3 +1,3 @@ -require_relative 'code_objects/puppet_namespace_object' -require_relative 'code_objects/defined_type_object' -require_relative 'code_objects/host_class_object' +require 'puppetx/puppetlabs/strings/yard/code_objects/puppet_namespace_object' +require 'puppetx/puppetlabs/strings/yard/code_objects/defined_type_object' +require 'puppetx/puppetlabs/strings/yard/code_objects/host_class_object' diff --git a/lib/puppetx/puppetlabs/strings/yard/code_objects/defined_type_object.rb b/lib/puppetx/puppetlabs/strings/yard/code_objects/defined_type_object.rb index f6a4c7f..aaafc92 100644 --- a/lib/puppetx/puppetlabs/strings/yard/code_objects/defined_type_object.rb +++ b/lib/puppetx/puppetlabs/strings/yard/code_objects/defined_type_object.rb @@ -1,6 +1,6 @@ require 'puppet/pops' -require_relative 'puppet_namespace_object' +require 'puppetx/puppetlabs/strings/yard/code_objects/puppet_namespace_object' module Puppetx::PuppetLabs::Strings::YARD::CodeObjects class DefinedTypeObject < PuppetNamespaceObject diff --git a/lib/puppetx/puppetlabs/strings/yard/code_objects/host_class_object.rb b/lib/puppetx/puppetlabs/strings/yard/code_objects/host_class_object.rb index 3d94267..1cc5022 100644 --- a/lib/puppetx/puppetlabs/strings/yard/code_objects/host_class_object.rb +++ b/lib/puppetx/puppetlabs/strings/yard/code_objects/host_class_object.rb @@ -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 class HostClassObject < DefinedTypeObject diff --git a/lib/puppetx/puppetlabs/strings/yard/code_objects/puppet_namespace_object.rb b/lib/puppetx/puppetlabs/strings/yard/code_objects/puppet_namespace_object.rb index 1dd0517..4fd0f47 100644 --- a/lib/puppetx/puppetlabs/strings/yard/code_objects/puppet_namespace_object.rb +++ b/lib/puppetx/puppetlabs/strings/yard/code_objects/puppet_namespace_object.rb @@ -1,6 +1,5 @@ require 'yard' - -require_relative '../../../strings' +require 'puppetx/puppetlabs/strings' module Puppetx::PuppetLabs::Strings::YARD::CodeObjects class PuppetNamespaceObject < YARD::CodeObjects::NamespaceObject diff --git a/lib/puppetx/puppetlabs/strings/yard/handlers.rb b/lib/puppetx/puppetlabs/strings/yard/handlers.rb index 3e3f694..19cc4ea 100644 --- a/lib/puppetx/puppetlabs/strings/yard/handlers.rb +++ b/lib/puppetx/puppetlabs/strings/yard/handlers.rb @@ -1,6 +1,6 @@ -require_relative 'handlers/base' -require_relative 'handlers/defined_type_handler' -require_relative 'handlers/host_class_handler' +require 'puppetx/puppetlabs/strings/yard/handlers/base' +require 'puppetx/puppetlabs/strings/yard/handlers/defined_type_handler' +require 'puppetx/puppetlabs/strings/yard/handlers/host_class_handler' -require_relative 'handlers/puppet_3x_function_handler' -require_relative 'handlers/puppet_4x_function_handler' +require 'puppetx/puppetlabs/strings/yard/handlers/puppet_3x_function_handler' +require 'puppetx/puppetlabs/strings/yard/handlers/puppet_4x_function_handler' diff --git a/lib/puppetx/puppetlabs/strings/yard/handlers/base.rb b/lib/puppetx/puppetlabs/strings/yard/handlers/base.rb index f0be1f6..2b637da 100644 --- a/lib/puppetx/puppetlabs/strings/yard/handlers/base.rb +++ b/lib/puppetx/puppetlabs/strings/yard/handlers/base.rb @@ -1,8 +1,8 @@ require 'yard' require 'puppet/pops' -require_relative '../../../strings' -require_relative '../code_objects' +require 'puppetx/puppetlabs/strings' +require 'puppetx/puppetlabs/strings/yard/code_objects' module Puppetx::PuppetLabs::Strings::YARD::Handlers class Base < YARD::Handlers::Base diff --git a/lib/puppetx/puppetlabs/strings/yard/handlers/defined_type_handler.rb b/lib/puppetx/puppetlabs/strings/yard/handlers/defined_type_handler.rb index 9b4ac50..74297a7 100644 --- a/lib/puppetx/puppetlabs/strings/yard/handlers/defined_type_handler.rb +++ b/lib/puppetx/puppetlabs/strings/yard/handlers/defined_type_handler.rb @@ -1,4 +1,4 @@ -require_relative 'base' +require 'puppetx/puppetlabs/strings/yard/handlers/base' module Puppetx::PuppetLabs::Strings::YARD::Handlers class DefinedTypeHandler < Base diff --git a/lib/puppetx/puppetlabs/strings/yard/handlers/host_class_handler.rb b/lib/puppetx/puppetlabs/strings/yard/handlers/host_class_handler.rb index 7a1e395..405acee 100644 --- a/lib/puppetx/puppetlabs/strings/yard/handlers/host_class_handler.rb +++ b/lib/puppetx/puppetlabs/strings/yard/handlers/host_class_handler.rb @@ -1,4 +1,4 @@ -require_relative 'base' +require 'puppetx/puppetlabs/strings/yard/handlers/base' module Puppetx::PuppetLabs::Strings::YARD::Handlers class HostClassHandler < Base diff --git a/lib/puppetx/puppetlabs/strings/yard/handlers/puppet_3x_function_handler.rb b/lib/puppetx/puppetlabs/strings/yard/handlers/puppet_3x_function_handler.rb index 8c174cf..8b4bfb3 100644 --- a/lib/puppetx/puppetlabs/strings/yard/handlers/puppet_3x_function_handler.rb +++ b/lib/puppetx/puppetlabs/strings/yard/handlers/puppet_3x_function_handler.rb @@ -1,7 +1,6 @@ # This utility library contains some tools for working with Puppet docstrings. require 'puppet/util/docs' - -require_relative '../code_objects' +require 'puppetx/puppetlabs/strings/yard/code_objects' module Puppetx::PuppetLabs::Strings::YARD::Handlers class Puppet3xFunctionHandler < YARD::Handlers::Ruby::Base diff --git a/lib/puppetx/puppetlabs/strings/yard/handlers/puppet_4x_function_handler.rb b/lib/puppetx/puppetlabs/strings/yard/handlers/puppet_4x_function_handler.rb index f52edb8..94c4fd5 100644 --- a/lib/puppetx/puppetlabs/strings/yard/handlers/puppet_4x_function_handler.rb +++ b/lib/puppetx/puppetlabs/strings/yard/handlers/puppet_4x_function_handler.rb @@ -1,4 +1,4 @@ -require_relative '../code_objects' +require 'puppetx/puppetlabs/strings/yard/code_objects' module Puppetx::PuppetLabs::Strings::YARD::Handlers # Handles `dispatch` calls within a future parser function declaration. For diff --git a/lib/puppetx/puppetlabs/strings/yard/parser.rb b/lib/puppetx/puppetlabs/strings/yard/parser.rb index 50923bd..0245540 100644 --- a/lib/puppetx/puppetlabs/strings/yard/parser.rb +++ b/lib/puppetx/puppetlabs/strings/yard/parser.rb @@ -1,8 +1,8 @@ require 'yard' require 'puppet/pops' -require_relative '../../strings' -require_relative '../pops/yard_transformer' +require 'puppetx/puppetlabs/strings' +require 'puppetx/puppetlabs/strings//pops/yard_transformer' module Puppetx::PuppetLabs::Strings::YARD class PuppetParser < YARD::Parser::Base diff --git a/lib/puppetx/puppetlabs/strings/yard/plugin.rb b/lib/puppetx/puppetlabs/strings/yard/plugin.rb index 58fd0da..b71e05e 100644 --- a/lib/puppetx/puppetlabs/strings/yard/plugin.rb +++ b/lib/puppetx/puppetlabs/strings/yard/plugin.rb @@ -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_relative 'monkey_patches' -require_relative 'parser' -require_relative 'handlers' +require 'puppetx/puppetlabs/strings/yard/monkey_patches' +require 'puppetx/puppetlabs/strings/yard/parser' +require 'puppetx/puppetlabs/strings/yard/handlers' YARD::Parser::SourceParser.register_parser_type(:puppet, Puppetx::PuppetLabs::Strings::YARD::PuppetParser,