From e5691d23c76190f94ad48008f8692fb43016f348 Mon Sep 17 00:00:00 2001 From: Hailee Kenney Date: Tue, 3 Feb 2015 15:06:30 -0800 Subject: [PATCH] (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. --- lib/puppet/face/strings.rb | 8 ++--- .../puppetlabs/strings.rb | 34 ++++++++++--------- .../puppetlabs/strings/actions.rb | 4 +-- .../puppetlabs/strings/pops/yard_statement.rb | 2 +- .../strings/pops/yard_transformer.rb | 6 ++-- .../yard/code_objects/defined_type_object.rb | 2 +- .../yard/code_objects/host_class_object.rb | 4 +-- .../code_objects/puppet_namespace_object.rb | 2 +- .../puppetlabs/strings/yard/handlers/base.rb | 4 +-- .../yard/handlers/defined_type_handler.rb | 2 +- .../yard/handlers/host_class_handler.rb | 2 +- .../handlers/puppet_3x_function_handler.rb | 4 +-- .../handlers/puppet_4x_function_handler.rb | 6 ++-- .../puppetlabs/strings/yard/monkey_patches.rb | 0 .../puppetlabs/strings/yard/parser.rb | 8 ++--- .../default/definedtype/html/docstring.erb | 0 .../default/definedtype/html/header.erb | 0 .../definedtype/html/parameter_details.erb | 0 .../default/definedtype/html/setup.rb | 0 .../templates/default/definedtype/setup.rb | 0 .../default/fulldoc/html/full_list_class.erb | 0 .../html/full_list_puppet_manifest.erb | 0 .../fulldoc/html/full_list_puppet_plugin.erb | 0 .../templates/default/fulldoc/html/setup.rb | 0 .../default/hostclass/html/box_info.erb | 0 .../templates/default/hostclass/html/setup.rb | 0 .../default/hostclass/html/subclasses.erb | 0 .../yard/templates/default/hostclass/setup.rb | 0 .../yard/templates/default/html_helper.rb | 0 .../templates/default/layout/html/setup.rb | 0 .../default/puppetnamespace/html/box_info.erb | 0 .../default/puppetnamespace/html/header.erb | 0 .../html/method_details_list.erb | 0 .../puppetnamespace/html/method_summary.erb | 0 .../default/puppetnamespace/html/setup.rb | 0 .../default/puppetnamespace/setup.rb | 0 .../yard/templates/default/template_helper.rb | 0 spec/spec_helper.rb | 2 +- .../puppetlabs/strings/pops_spec.rb | 10 +++--- .../strings/yard/defined_type_handler_spec.rb | 4 +-- .../strings/yard/host_class_handler_spec.rb | 4 +-- .../yard/puppet_3x_function_handler_spec.rb | 4 +-- .../yard/puppet_4x_function_handler_spec.rb | 4 +-- 43 files changed, 59 insertions(+), 57 deletions(-) rename lib/{puppetx => puppet_x}/puppetlabs/strings.rb (54%) rename lib/{puppetx => puppet_x}/puppetlabs/strings/actions.rb (97%) rename lib/{puppetx => puppet_x}/puppetlabs/strings/pops/yard_statement.rb (97%) rename lib/{puppetx => puppet_x}/puppetlabs/strings/pops/yard_transformer.rb (85%) rename lib/{puppetx => puppet_x}/puppetlabs/strings/yard/code_objects/defined_type_object.rb (52%) rename lib/{puppetx => puppet_x}/puppetlabs/strings/yard/code_objects/host_class_object.rb (81%) rename lib/{puppetx => puppet_x}/puppetlabs/strings/yard/code_objects/puppet_namespace_object.rb (95%) rename lib/{puppetx => puppet_x}/puppetlabs/strings/yard/handlers/base.rb (68%) rename lib/{puppetx => puppet_x}/puppetlabs/strings/yard/handlers/defined_type_handler.rb (71%) rename lib/{puppetx => puppet_x}/puppetlabs/strings/yard/handlers/host_class_handler.rb (78%) rename lib/{puppetx => puppet_x}/puppetlabs/strings/yard/handlers/puppet_3x_function_handler.rb (96%) rename lib/{puppetx => puppet_x}/puppetlabs/strings/yard/handlers/puppet_4x_function_handler.rb (95%) rename lib/{puppetx => puppet_x}/puppetlabs/strings/yard/monkey_patches.rb (100%) rename lib/{puppetx => puppet_x}/puppetlabs/strings/yard/parser.rb (67%) rename lib/{puppetx => puppet_x}/puppetlabs/strings/yard/templates/default/definedtype/html/docstring.erb (100%) rename lib/{puppetx => puppet_x}/puppetlabs/strings/yard/templates/default/definedtype/html/header.erb (100%) rename lib/{puppetx => puppet_x}/puppetlabs/strings/yard/templates/default/definedtype/html/parameter_details.erb (100%) rename lib/{puppetx => puppet_x}/puppetlabs/strings/yard/templates/default/definedtype/html/setup.rb (100%) rename lib/{puppetx => puppet_x}/puppetlabs/strings/yard/templates/default/definedtype/setup.rb (100%) rename lib/{puppetx => puppet_x}/puppetlabs/strings/yard/templates/default/fulldoc/html/full_list_class.erb (100%) rename lib/{puppetx => puppet_x}/puppetlabs/strings/yard/templates/default/fulldoc/html/full_list_puppet_manifest.erb (100%) rename lib/{puppetx => puppet_x}/puppetlabs/strings/yard/templates/default/fulldoc/html/full_list_puppet_plugin.erb (100%) rename lib/{puppetx => puppet_x}/puppetlabs/strings/yard/templates/default/fulldoc/html/setup.rb (100%) rename lib/{puppetx => puppet_x}/puppetlabs/strings/yard/templates/default/hostclass/html/box_info.erb (100%) rename lib/{puppetx => puppet_x}/puppetlabs/strings/yard/templates/default/hostclass/html/setup.rb (100%) rename lib/{puppetx => puppet_x}/puppetlabs/strings/yard/templates/default/hostclass/html/subclasses.erb (100%) rename lib/{puppetx => puppet_x}/puppetlabs/strings/yard/templates/default/hostclass/setup.rb (100%) rename lib/{puppetx => puppet_x}/puppetlabs/strings/yard/templates/default/html_helper.rb (100%) rename lib/{puppetx => puppet_x}/puppetlabs/strings/yard/templates/default/layout/html/setup.rb (100%) rename lib/{puppetx => puppet_x}/puppetlabs/strings/yard/templates/default/puppetnamespace/html/box_info.erb (100%) rename lib/{puppetx => puppet_x}/puppetlabs/strings/yard/templates/default/puppetnamespace/html/header.erb (100%) rename lib/{puppetx => puppet_x}/puppetlabs/strings/yard/templates/default/puppetnamespace/html/method_details_list.erb (100%) rename lib/{puppetx => puppet_x}/puppetlabs/strings/yard/templates/default/puppetnamespace/html/method_summary.erb (100%) rename lib/{puppetx => puppet_x}/puppetlabs/strings/yard/templates/default/puppetnamespace/html/setup.rb (100%) rename lib/{puppetx => puppet_x}/puppetlabs/strings/yard/templates/default/puppetnamespace/setup.rb (100%) rename lib/{puppetx => puppet_x}/puppetlabs/strings/yard/templates/default/template_helper.rb (100%) rename spec/unit/{puppetx => puppet_x}/puppetlabs/strings/pops_spec.rb (80%) rename spec/unit/{puppetx => puppet_x}/puppetlabs/strings/yard/defined_type_handler_spec.rb (91%) rename spec/unit/{puppetx => puppet_x}/puppetlabs/strings/yard/host_class_handler_spec.rb (89%) rename spec/unit/{puppetx => puppet_x}/puppetlabs/strings/yard/puppet_3x_function_handler_spec.rb (91%) rename spec/unit/{puppetx => puppet_x}/puppetlabs/strings/yard/puppet_4x_function_handler_spec.rb (92%) diff --git a/lib/puppet/face/strings.rb b/lib/puppet/face/strings.rb index 4b24bee..e0221a5 100644 --- a/lib/puppet/face/strings.rb +++ b/lib/puppet/face/strings.rb @@ -33,9 +33,9 @@ Puppet::Face.define(:strings, '0.0.1') do when_invoked do |*args| check_required_features - require 'puppetx/puppetlabs/strings/actions' + require 'puppet_x/puppetlabs/strings/actions' - yardoc_actions = Puppetx::PuppetLabs::Strings::Actions.new(Puppet[:debug], Puppet[:trace]) + yardoc_actions = PuppetX::PuppetLabs::Strings::Actions.new(Puppet[:debug], Puppet[:trace]) # The last element of the argument array should be the options hash. # We don't have any options yet, so for now just pop the hash off and @@ -65,9 +65,9 @@ Puppet::Face.define(:strings, '0.0.1') do when_invoked do |*args| check_required_features - require 'puppetx/puppetlabs/strings/actions' + require 'puppet_x/puppetlabs/strings/actions' - server_actions = Puppetx::PuppetLabs::Strings::Actions.new(Puppet[:debug], Puppet[:trace]) + server_actions = PuppetX::PuppetLabs::Strings::Actions.new(Puppet[:debug], Puppet[:trace]) args.pop diff --git a/lib/puppetx/puppetlabs/strings.rb b/lib/puppet_x/puppetlabs/strings.rb similarity index 54% rename from lib/puppetx/puppetlabs/strings.rb rename to lib/puppet_x/puppetlabs/strings.rb index 03b2de8..2bf4c16 100644 --- a/lib/puppetx/puppetlabs/strings.rb +++ b/lib/puppet_x/puppetlabs/strings.rb @@ -1,48 +1,50 @@ require 'puppet' require 'puppet/pops' -require 'puppetx' require 'puppet/util/docs' require 'yard' +module PuppetX +end + # Nothing to see here except forward declarations. -module Puppetx::PuppetLabs +module PuppetX::PuppetLabs module Strings # This submodule contains bits that operate on the Pops module produced by # the Future parser. module Pops - require 'puppetx/puppetlabs/strings/pops/yard_statement' - require 'puppetx/puppetlabs/strings/pops/yard_transformer' + require 'puppet_x/puppetlabs/strings/pops/yard_statement' + require 'puppet_x/puppetlabs/strings/pops/yard_transformer' end # This submodule contains bits that interface with the YARD plugin system. module YARD - require 'puppetx/puppetlabs/strings/yard/monkey_patches' - require 'puppetx/puppetlabs/strings/yard/parser' + require 'puppet_x/puppetlabs/strings/yard/monkey_patches' + require 'puppet_x/puppetlabs/strings/yard/parser' # This submodule contains code objects which are used to represent relevant # aspects of puppet code in YARD's Registry module CodeObjects - 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' + 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' 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 - 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 'puppetx/puppetlabs/strings/yard/handlers/puppet_3x_function_handler' - require 'puppetx/puppetlabs/strings/yard/handlers/puppet_4x_function_handler' + 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' end ::YARD::Parser::SourceParser.register_parser_type(:puppet, - Puppetx::PuppetLabs::Strings::YARD::PuppetParser, + PuppetX::PuppetLabs::Strings::YARD::PuppetParser, ['pp']) ::YARD::Handlers::Processor.register_handler_namespace(:puppet, - Puppetx::PuppetLabs::Strings::YARD::Handlers) + PuppetX::PuppetLabs::Strings::YARD::Handlers) # 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. diff --git a/lib/puppetx/puppetlabs/strings/actions.rb b/lib/puppet_x/puppetlabs/strings/actions.rb similarity index 97% rename from lib/puppetx/puppetlabs/strings/actions.rb rename to lib/puppet_x/puppetlabs/strings/actions.rb index 628c41b..50da802 100644 --- a/lib/puppetx/puppetlabs/strings/actions.rb +++ b/lib/puppet_x/puppetlabs/strings/actions.rb @@ -1,6 +1,6 @@ -require 'puppetx/puppetlabs/strings' +require 'puppet_x/puppetlabs/strings' -class Puppetx::PuppetLabs::Strings::Actions +class PuppetX::PuppetLabs::Strings::Actions # Creates a new instance of the Actions class by determining # whether or not debug and backtrace arguments should be sent diff --git a/lib/puppetx/puppetlabs/strings/pops/yard_statement.rb b/lib/puppet_x/puppetlabs/strings/pops/yard_statement.rb similarity index 97% rename from lib/puppetx/puppetlabs/strings/pops/yard_statement.rb rename to lib/puppet_x/puppetlabs/strings/pops/yard_statement.rb index 924085a..9271319 100644 --- a/lib/puppetx/puppetlabs/strings/pops/yard_statement.rb +++ b/lib/puppet_x/puppetlabs/strings/pops/yard_statement.rb @@ -6,7 +6,7 @@ require 'ostruct' # FIXME: Inhertiting from OpenStruct is a bit of a hack. It allows attributes # to be declared as needed but in the long run understandibility of the code # would be improved by having a concrete model. -class Puppetx::PuppetLabs::Strings::Pops::YARDStatement < OpenStruct +class PuppetX::PuppetLabs::Strings::Pops::YARDStatement < OpenStruct attr_reader :pops_obj, :comments def initialize(pops_obj) diff --git a/lib/puppetx/puppetlabs/strings/pops/yard_transformer.rb b/lib/puppet_x/puppetlabs/strings/pops/yard_transformer.rb similarity index 85% rename from lib/puppetx/puppetlabs/strings/pops/yard_transformer.rb rename to lib/puppet_x/puppetlabs/strings/pops/yard_transformer.rb index f386add..0a47435 100644 --- a/lib/puppetx/puppetlabs/strings/pops/yard_transformer.rb +++ b/lib/puppet_x/puppetlabs/strings/pops/yard_transformer.rb @@ -4,7 +4,7 @@ # # @note Currently, this class only extracts node, host class and type # definitions. -class Puppetx::PuppetLabs::Strings::Pops::YARDTransformer +class PuppetX::PuppetLabs::Strings::Pops::YARDTransformer def initialize @transform_visitor = Puppet::Pops::Visitor.new(self, 'transform') end @@ -26,7 +26,7 @@ class Puppetx::PuppetLabs::Strings::Pops::YARDTransformer # Extract comments from type definitions and class definitions. Wrap them # into YARDStatement objects that provide an interface for YARD handlers. def transform_NamedDefinition(o) - obj = Puppetx::PuppetLabs::Strings::Pops::YARDStatement.new(o) + obj = PuppetX::PuppetLabs::Strings::Pops::YARDStatement.new(o) obj.parameters = o.parameters.map do |p| param_tuple = [transform(p)] param_tuple << ( p.value.nil? ? nil : transform(p.value) ) @@ -37,7 +37,7 @@ class Puppetx::PuppetLabs::Strings::Pops::YARDTransformer # Catch-all visitor. def transform_Positioned(o) - Puppetx::PuppetLabs::Strings::Pops::YARDStatement.new(o) + PuppetX::PuppetLabs::Strings::Pops::YARDStatement.new(o) end # nil in... nil out! diff --git a/lib/puppetx/puppetlabs/strings/yard/code_objects/defined_type_object.rb b/lib/puppet_x/puppetlabs/strings/yard/code_objects/defined_type_object.rb similarity index 52% rename from lib/puppetx/puppetlabs/strings/yard/code_objects/defined_type_object.rb rename to lib/puppet_x/puppetlabs/strings/yard/code_objects/defined_type_object.rb index c4fbe8e..24f6894 100644 --- a/lib/puppetx/puppetlabs/strings/yard/code_objects/defined_type_object.rb +++ b/lib/puppet_x/puppetlabs/strings/yard/code_objects/defined_type_object.rb @@ -1,4 +1,4 @@ -class Puppetx::PuppetLabs::Strings::YARD::CodeObjects::DefinedTypeObject < Puppetx::PuppetLabs::Strings::YARD::CodeObjects::PuppetNamespaceObject +class PuppetX::PuppetLabs::Strings::YARD::CodeObjects::DefinedTypeObject < PuppetX::PuppetLabs::Strings::YARD::CodeObjects::PuppetNamespaceObject # A list of parameters attached to this class. # @return [Array] attr_accessor :parameters diff --git a/lib/puppetx/puppetlabs/strings/yard/code_objects/host_class_object.rb b/lib/puppet_x/puppetlabs/strings/yard/code_objects/host_class_object.rb similarity index 81% rename from lib/puppetx/puppetlabs/strings/yard/code_objects/host_class_object.rb rename to lib/puppet_x/puppetlabs/strings/yard/code_objects/host_class_object.rb index 5f5dda7..0fc1c53 100644 --- a/lib/puppetx/puppetlabs/strings/yard/code_objects/host_class_object.rb +++ b/lib/puppet_x/puppetlabs/strings/yard/code_objects/host_class_object.rb @@ -1,4 +1,4 @@ -class Puppetx::PuppetLabs::Strings::YARD::CodeObjects::HostClassObject < Puppetx::PuppetLabs::Strings::YARD::CodeObjects::DefinedTypeObject +class PuppetX::PuppetLabs::Strings::YARD::CodeObjects::HostClassObject < PuppetX::PuppetLabs::Strings::YARD::CodeObjects::DefinedTypeObject # The {HostClassObject} that this class inherits from, if any. # @return [HostClassObject, Proxy, nil] attr_accessor :parent_class @@ -6,7 +6,7 @@ class Puppetx::PuppetLabs::Strings::YARD::CodeObjects::HostClassObject < Puppetx # NOTE: `include_mods` is never used as it makes no sense for Puppet, but # this is called by `YARD::Registry` and it will pass a parameter. def inheritance_tree(include_mods = false) - if parent_class.is_a?(Puppetx::PuppetLabs::Strings::YARD::CodeObjects::HostClassObject) + if parent_class.is_a?(PuppetX::PuppetLabs::Strings::YARD::CodeObjects::HostClassObject) # Cool. We got a host class. Return self + parent inheritance tree. [self] + parent_class.inheritance_tree elsif parent_class.is_a?(YARD::CodeObjects::Proxy) diff --git a/lib/puppetx/puppetlabs/strings/yard/code_objects/puppet_namespace_object.rb b/lib/puppet_x/puppetlabs/strings/yard/code_objects/puppet_namespace_object.rb similarity index 95% rename from lib/puppetx/puppetlabs/strings/yard/code_objects/puppet_namespace_object.rb rename to lib/puppet_x/puppetlabs/strings/yard/code_objects/puppet_namespace_object.rb index f619a45..0497269 100644 --- a/lib/puppetx/puppetlabs/strings/yard/code_objects/puppet_namespace_object.rb +++ b/lib/puppet_x/puppetlabs/strings/yard/code_objects/puppet_namespace_object.rb @@ -1,4 +1,4 @@ -class Puppetx::PuppetLabs::Strings::YARD::CodeObjects::PuppetNamespaceObject < YARD::CodeObjects::NamespaceObject +class PuppetX::PuppetLabs::Strings::YARD::CodeObjects::PuppetNamespaceObject < YARD::CodeObjects::NamespaceObject # NOTE: `YARD::Registry#resolve` requires a method with this signature to # be present on all subclasses of `NamespaceObject`. def inheritance_tree(include_mods = false) diff --git a/lib/puppetx/puppetlabs/strings/yard/handlers/base.rb b/lib/puppet_x/puppetlabs/strings/yard/handlers/base.rb similarity index 68% rename from lib/puppetx/puppetlabs/strings/yard/handlers/base.rb rename to lib/puppet_x/puppetlabs/strings/yard/handlers/base.rb index 1b9ec24..e601d08 100644 --- a/lib/puppetx/puppetlabs/strings/yard/handlers/base.rb +++ b/lib/puppet_x/puppetlabs/strings/yard/handlers/base.rb @@ -1,8 +1,8 @@ -class Puppetx::PuppetLabs::Strings::YARD::Handlers::Base < YARD::Handlers::Base +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 + include PuppetX::PuppetLabs::Strings::YARD::CodeObjects def self.handles?(statement) handlers.any? {|h| h == statement.type} diff --git a/lib/puppetx/puppetlabs/strings/yard/handlers/defined_type_handler.rb b/lib/puppet_x/puppetlabs/strings/yard/handlers/defined_type_handler.rb similarity index 71% rename from lib/puppetx/puppetlabs/strings/yard/handlers/defined_type_handler.rb rename to lib/puppet_x/puppetlabs/strings/yard/handlers/defined_type_handler.rb index 3259b0f..6e0a51a 100644 --- a/lib/puppetx/puppetlabs/strings/yard/handlers/defined_type_handler.rb +++ b/lib/puppet_x/puppetlabs/strings/yard/handlers/defined_type_handler.rb @@ -1,4 +1,4 @@ -class Puppetx::PuppetLabs::Strings::YARD::Handlers::DefinedTypeHandler < Puppetx::PuppetLabs::Strings::YARD::Handlers:: Base +class PuppetX::PuppetLabs::Strings::YARD::Handlers::DefinedTypeHandler < PuppetX::PuppetLabs::Strings::YARD::Handlers:: Base handles ResourceTypeDefinition process do diff --git a/lib/puppetx/puppetlabs/strings/yard/handlers/host_class_handler.rb b/lib/puppet_x/puppetlabs/strings/yard/handlers/host_class_handler.rb similarity index 78% rename from lib/puppetx/puppetlabs/strings/yard/handlers/host_class_handler.rb rename to lib/puppet_x/puppetlabs/strings/yard/handlers/host_class_handler.rb index 9e346cd..af7a4ef 100644 --- a/lib/puppetx/puppetlabs/strings/yard/handlers/host_class_handler.rb +++ b/lib/puppet_x/puppetlabs/strings/yard/handlers/host_class_handler.rb @@ -1,4 +1,4 @@ -class Puppetx::PuppetLabs::Strings::YARD::Handlers::HostClassHandler < Puppetx::PuppetLabs::Strings::YARD::Handlers::Base +class PuppetX::PuppetLabs::Strings::YARD::Handlers::HostClassHandler < PuppetX::PuppetLabs::Strings::YARD::Handlers::Base handles HostClassDefinition process do diff --git a/lib/puppetx/puppetlabs/strings/yard/handlers/puppet_3x_function_handler.rb b/lib/puppet_x/puppetlabs/strings/yard/handlers/puppet_3x_function_handler.rb similarity index 96% rename from lib/puppetx/puppetlabs/strings/yard/handlers/puppet_3x_function_handler.rb rename to lib/puppet_x/puppetlabs/strings/yard/handlers/puppet_3x_function_handler.rb index 0083eca..116c71b 100644 --- a/lib/puppetx/puppetlabs/strings/yard/handlers/puppet_3x_function_handler.rb +++ b/lib/puppet_x/puppetlabs/strings/yard/handlers/puppet_3x_function_handler.rb @@ -1,5 +1,5 @@ -class Puppetx::PuppetLabs::Strings::YARD::Handlers::Puppet3xFunctionHandler < YARD::Handlers::Ruby::Base - include Puppetx::PuppetLabs::Strings::YARD::CodeObjects +class PuppetX::PuppetLabs::Strings::YARD::Handlers::Puppet3xFunctionHandler < YARD::Handlers::Ruby::Base + include PuppetX::PuppetLabs::Strings::YARD::CodeObjects handles method_call(:newfunction) diff --git a/lib/puppetx/puppetlabs/strings/yard/handlers/puppet_4x_function_handler.rb b/lib/puppet_x/puppetlabs/strings/yard/handlers/puppet_4x_function_handler.rb similarity index 95% rename from lib/puppetx/puppetlabs/strings/yard/handlers/puppet_4x_function_handler.rb rename to lib/puppet_x/puppetlabs/strings/yard/handlers/puppet_4x_function_handler.rb index 4f4d654..29b7b22 100644 --- a/lib/puppetx/puppetlabs/strings/yard/handlers/puppet_4x_function_handler.rb +++ b/lib/puppet_x/puppetlabs/strings/yard/handlers/puppet_4x_function_handler.rb @@ -1,8 +1,8 @@ # Handles `dispatch` calls within a future parser function declaration. For # now, it just treats any docstring as an `@overlaod` tag and attaches the # overload to the parent function. -class Puppetx::PuppetLabs::Strings::YARD::Handlers::Puppet4xFunctionHandler < YARD::Handlers::Ruby::Base - include Puppetx::PuppetLabs::Strings::YARD::CodeObjects +class PuppetX::PuppetLabs::Strings::YARD::Handlers::Puppet4xFunctionHandler < YARD::Handlers::Ruby::Base + include PuppetX::PuppetLabs::Strings::YARD::CodeObjects handles method_call(:dispatch) @@ -19,7 +19,7 @@ class Puppetx::PuppetLabs::Strings::YARD::Handlers::Puppet4xFunctionHandler < YA end class Puppet4xFunctionHandler < YARD::Handlers::Ruby::Base - include Puppetx::PuppetLabs::Strings::YARD::CodeObjects + include PuppetX::PuppetLabs::Strings::YARD::CodeObjects handles method_call(:create_function) diff --git a/lib/puppetx/puppetlabs/strings/yard/monkey_patches.rb b/lib/puppet_x/puppetlabs/strings/yard/monkey_patches.rb similarity index 100% rename from lib/puppetx/puppetlabs/strings/yard/monkey_patches.rb rename to lib/puppet_x/puppetlabs/strings/yard/monkey_patches.rb diff --git a/lib/puppetx/puppetlabs/strings/yard/parser.rb b/lib/puppet_x/puppetlabs/strings/yard/parser.rb similarity index 67% rename from lib/puppetx/puppetlabs/strings/yard/parser.rb rename to lib/puppet_x/puppetlabs/strings/yard/parser.rb index a404219..7237425 100644 --- a/lib/puppetx/puppetlabs/strings/yard/parser.rb +++ b/lib/puppet_x/puppetlabs/strings/yard/parser.rb @@ -1,10 +1,10 @@ require 'yard' require 'puppet/pops' -require 'puppetx/puppetlabs/strings' -require 'puppetx/puppetlabs/strings//pops/yard_transformer' +require 'puppet_x/puppetlabs/strings' +require 'puppet_x/puppetlabs/strings//pops/yard_transformer' -class Puppetx::PuppetLabs::Strings::YARD::PuppetParser < YARD::Parser::Base +class PuppetX::PuppetLabs::Strings::YARD::PuppetParser < YARD::Parser::Base attr_reader :file, :source def initialize(source, filename) @@ -12,7 +12,7 @@ class Puppetx::PuppetLabs::Strings::YARD::PuppetParser < YARD::Parser::Base @file = filename @parser = Puppet::Pops::Parser::Parser.new() - @transformer = Puppetx::PuppetLabs::Strings::Pops::YARDTransformer.new() + @transformer = PuppetX::PuppetLabs::Strings::Pops::YARDTransformer.new() end def parse diff --git a/lib/puppetx/puppetlabs/strings/yard/templates/default/definedtype/html/docstring.erb b/lib/puppet_x/puppetlabs/strings/yard/templates/default/definedtype/html/docstring.erb similarity index 100% rename from lib/puppetx/puppetlabs/strings/yard/templates/default/definedtype/html/docstring.erb rename to lib/puppet_x/puppetlabs/strings/yard/templates/default/definedtype/html/docstring.erb diff --git a/lib/puppetx/puppetlabs/strings/yard/templates/default/definedtype/html/header.erb b/lib/puppet_x/puppetlabs/strings/yard/templates/default/definedtype/html/header.erb similarity index 100% rename from lib/puppetx/puppetlabs/strings/yard/templates/default/definedtype/html/header.erb rename to lib/puppet_x/puppetlabs/strings/yard/templates/default/definedtype/html/header.erb diff --git a/lib/puppetx/puppetlabs/strings/yard/templates/default/definedtype/html/parameter_details.erb b/lib/puppet_x/puppetlabs/strings/yard/templates/default/definedtype/html/parameter_details.erb similarity index 100% rename from lib/puppetx/puppetlabs/strings/yard/templates/default/definedtype/html/parameter_details.erb rename to lib/puppet_x/puppetlabs/strings/yard/templates/default/definedtype/html/parameter_details.erb diff --git a/lib/puppetx/puppetlabs/strings/yard/templates/default/definedtype/html/setup.rb b/lib/puppet_x/puppetlabs/strings/yard/templates/default/definedtype/html/setup.rb similarity index 100% rename from lib/puppetx/puppetlabs/strings/yard/templates/default/definedtype/html/setup.rb rename to lib/puppet_x/puppetlabs/strings/yard/templates/default/definedtype/html/setup.rb diff --git a/lib/puppetx/puppetlabs/strings/yard/templates/default/definedtype/setup.rb b/lib/puppet_x/puppetlabs/strings/yard/templates/default/definedtype/setup.rb similarity index 100% rename from lib/puppetx/puppetlabs/strings/yard/templates/default/definedtype/setup.rb rename to lib/puppet_x/puppetlabs/strings/yard/templates/default/definedtype/setup.rb diff --git a/lib/puppetx/puppetlabs/strings/yard/templates/default/fulldoc/html/full_list_class.erb b/lib/puppet_x/puppetlabs/strings/yard/templates/default/fulldoc/html/full_list_class.erb similarity index 100% rename from lib/puppetx/puppetlabs/strings/yard/templates/default/fulldoc/html/full_list_class.erb rename to lib/puppet_x/puppetlabs/strings/yard/templates/default/fulldoc/html/full_list_class.erb diff --git a/lib/puppetx/puppetlabs/strings/yard/templates/default/fulldoc/html/full_list_puppet_manifest.erb b/lib/puppet_x/puppetlabs/strings/yard/templates/default/fulldoc/html/full_list_puppet_manifest.erb similarity index 100% rename from lib/puppetx/puppetlabs/strings/yard/templates/default/fulldoc/html/full_list_puppet_manifest.erb rename to lib/puppet_x/puppetlabs/strings/yard/templates/default/fulldoc/html/full_list_puppet_manifest.erb diff --git a/lib/puppetx/puppetlabs/strings/yard/templates/default/fulldoc/html/full_list_puppet_plugin.erb b/lib/puppet_x/puppetlabs/strings/yard/templates/default/fulldoc/html/full_list_puppet_plugin.erb similarity index 100% rename from lib/puppetx/puppetlabs/strings/yard/templates/default/fulldoc/html/full_list_puppet_plugin.erb rename to lib/puppet_x/puppetlabs/strings/yard/templates/default/fulldoc/html/full_list_puppet_plugin.erb diff --git a/lib/puppetx/puppetlabs/strings/yard/templates/default/fulldoc/html/setup.rb b/lib/puppet_x/puppetlabs/strings/yard/templates/default/fulldoc/html/setup.rb similarity index 100% rename from lib/puppetx/puppetlabs/strings/yard/templates/default/fulldoc/html/setup.rb rename to lib/puppet_x/puppetlabs/strings/yard/templates/default/fulldoc/html/setup.rb diff --git a/lib/puppetx/puppetlabs/strings/yard/templates/default/hostclass/html/box_info.erb b/lib/puppet_x/puppetlabs/strings/yard/templates/default/hostclass/html/box_info.erb similarity index 100% rename from lib/puppetx/puppetlabs/strings/yard/templates/default/hostclass/html/box_info.erb rename to lib/puppet_x/puppetlabs/strings/yard/templates/default/hostclass/html/box_info.erb diff --git a/lib/puppetx/puppetlabs/strings/yard/templates/default/hostclass/html/setup.rb b/lib/puppet_x/puppetlabs/strings/yard/templates/default/hostclass/html/setup.rb similarity index 100% rename from lib/puppetx/puppetlabs/strings/yard/templates/default/hostclass/html/setup.rb rename to lib/puppet_x/puppetlabs/strings/yard/templates/default/hostclass/html/setup.rb diff --git a/lib/puppetx/puppetlabs/strings/yard/templates/default/hostclass/html/subclasses.erb b/lib/puppet_x/puppetlabs/strings/yard/templates/default/hostclass/html/subclasses.erb similarity index 100% rename from lib/puppetx/puppetlabs/strings/yard/templates/default/hostclass/html/subclasses.erb rename to lib/puppet_x/puppetlabs/strings/yard/templates/default/hostclass/html/subclasses.erb diff --git a/lib/puppetx/puppetlabs/strings/yard/templates/default/hostclass/setup.rb b/lib/puppet_x/puppetlabs/strings/yard/templates/default/hostclass/setup.rb similarity index 100% rename from lib/puppetx/puppetlabs/strings/yard/templates/default/hostclass/setup.rb rename to lib/puppet_x/puppetlabs/strings/yard/templates/default/hostclass/setup.rb diff --git a/lib/puppetx/puppetlabs/strings/yard/templates/default/html_helper.rb b/lib/puppet_x/puppetlabs/strings/yard/templates/default/html_helper.rb similarity index 100% rename from lib/puppetx/puppetlabs/strings/yard/templates/default/html_helper.rb rename to lib/puppet_x/puppetlabs/strings/yard/templates/default/html_helper.rb diff --git a/lib/puppetx/puppetlabs/strings/yard/templates/default/layout/html/setup.rb b/lib/puppet_x/puppetlabs/strings/yard/templates/default/layout/html/setup.rb similarity index 100% rename from lib/puppetx/puppetlabs/strings/yard/templates/default/layout/html/setup.rb rename to lib/puppet_x/puppetlabs/strings/yard/templates/default/layout/html/setup.rb diff --git a/lib/puppetx/puppetlabs/strings/yard/templates/default/puppetnamespace/html/box_info.erb b/lib/puppet_x/puppetlabs/strings/yard/templates/default/puppetnamespace/html/box_info.erb similarity index 100% rename from lib/puppetx/puppetlabs/strings/yard/templates/default/puppetnamespace/html/box_info.erb rename to lib/puppet_x/puppetlabs/strings/yard/templates/default/puppetnamespace/html/box_info.erb diff --git a/lib/puppetx/puppetlabs/strings/yard/templates/default/puppetnamespace/html/header.erb b/lib/puppet_x/puppetlabs/strings/yard/templates/default/puppetnamespace/html/header.erb similarity index 100% rename from lib/puppetx/puppetlabs/strings/yard/templates/default/puppetnamespace/html/header.erb rename to lib/puppet_x/puppetlabs/strings/yard/templates/default/puppetnamespace/html/header.erb diff --git a/lib/puppetx/puppetlabs/strings/yard/templates/default/puppetnamespace/html/method_details_list.erb b/lib/puppet_x/puppetlabs/strings/yard/templates/default/puppetnamespace/html/method_details_list.erb similarity index 100% rename from lib/puppetx/puppetlabs/strings/yard/templates/default/puppetnamespace/html/method_details_list.erb rename to lib/puppet_x/puppetlabs/strings/yard/templates/default/puppetnamespace/html/method_details_list.erb diff --git a/lib/puppetx/puppetlabs/strings/yard/templates/default/puppetnamespace/html/method_summary.erb b/lib/puppet_x/puppetlabs/strings/yard/templates/default/puppetnamespace/html/method_summary.erb similarity index 100% rename from lib/puppetx/puppetlabs/strings/yard/templates/default/puppetnamespace/html/method_summary.erb rename to lib/puppet_x/puppetlabs/strings/yard/templates/default/puppetnamespace/html/method_summary.erb diff --git a/lib/puppetx/puppetlabs/strings/yard/templates/default/puppetnamespace/html/setup.rb b/lib/puppet_x/puppetlabs/strings/yard/templates/default/puppetnamespace/html/setup.rb similarity index 100% rename from lib/puppetx/puppetlabs/strings/yard/templates/default/puppetnamespace/html/setup.rb rename to lib/puppet_x/puppetlabs/strings/yard/templates/default/puppetnamespace/html/setup.rb diff --git a/lib/puppetx/puppetlabs/strings/yard/templates/default/puppetnamespace/setup.rb b/lib/puppet_x/puppetlabs/strings/yard/templates/default/puppetnamespace/setup.rb similarity index 100% rename from lib/puppetx/puppetlabs/strings/yard/templates/default/puppetnamespace/setup.rb rename to lib/puppet_x/puppetlabs/strings/yard/templates/default/puppetnamespace/setup.rb diff --git a/lib/puppetx/puppetlabs/strings/yard/templates/default/template_helper.rb b/lib/puppet_x/puppetlabs/strings/yard/templates/default/template_helper.rb similarity index 100% rename from lib/puppetx/puppetlabs/strings/yard/templates/default/template_helper.rb rename to lib/puppet_x/puppetlabs/strings/yard/templates/default/template_helper.rb diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb index 655e41f..a751957 100644 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -5,7 +5,7 @@ require 'mocha' require 'puppet' require 'rspec' -require 'puppetx/puppetlabs/strings' +require 'puppet_x/puppetlabs/strings' RSpec.configure do |config| config.mock_with :mocha diff --git a/spec/unit/puppetx/puppetlabs/strings/pops_spec.rb b/spec/unit/puppet_x/puppetlabs/strings/pops_spec.rb similarity index 80% rename from spec/unit/puppetx/puppetlabs/strings/pops_spec.rb rename to spec/unit/puppet_x/puppetlabs/strings/pops_spec.rb index d3a9d26..24e0193 100644 --- a/spec/unit/puppetx/puppetlabs/strings/pops_spec.rb +++ b/spec/unit/puppet_x/puppetlabs/strings/pops_spec.rb @@ -1,13 +1,13 @@ require 'spec_helper' -require 'puppetx/puppetlabs/strings/pops/yard_statement' +require 'puppet_x/puppetlabs/strings/pops/yard_statement' -describe Puppetx::PuppetLabs::Strings::Pops do +describe PuppetX::PuppetLabs::Strings::Pops do let(:parser) {Puppet::Pops::Parser::Parser.new()} describe "YARDstatement class" do let(:manifest) {"#hello world\nclass foo { }"} let(:model) {parser.parse_string(manifest).current.definitions.first} - let(:test_statement) {Puppetx::PuppetLabs::Strings::Pops::YARDStatement.new(model)} + let(:test_statement) {PuppetX::PuppetLabs::Strings::Pops::YARDStatement.new(model)} describe "when creating a new instance of YARDStatement" do it "should extract comments from the source code" do @@ -19,13 +19,13 @@ describe Puppetx::PuppetLabs::Strings::Pops do describe "YARDTransfomer class" do let(:manifest) {"#hello world\nclass foo($bar) { }"} let(:manifest_default) {"#hello world\nclass foo($bar = 3) { }"} - let(:transformer) {Puppetx::PuppetLabs::Strings::Pops::YARDTransformer.new} + let(:transformer) {PuppetX::PuppetLabs::Strings::Pops::YARDTransformer.new} describe "transform method" do it "should perform the correct transformation with parameter defaults" do model = parser.parse_string(manifest_default).current.definitions.first statements = transformer.transform(model) - expect(statements.parameters[0][0].class).to be(Puppetx::PuppetLabs::Strings::Pops::YARDStatement) + expect(statements.parameters[0][0].class).to be(PuppetX::PuppetLabs::Strings::Pops::YARDStatement) end it "should perform the correct transofmration without parameter defaults" do diff --git a/spec/unit/puppetx/puppetlabs/strings/yard/defined_type_handler_spec.rb b/spec/unit/puppet_x/puppetlabs/strings/yard/defined_type_handler_spec.rb similarity index 91% rename from spec/unit/puppetx/puppetlabs/strings/yard/defined_type_handler_spec.rb rename to spec/unit/puppet_x/puppetlabs/strings/yard/defined_type_handler_spec.rb index 955070f..7d684da 100644 --- a/spec/unit/puppetx/puppetlabs/strings/yard/defined_type_handler_spec.rb +++ b/spec/unit/puppet_x/puppetlabs/strings/yard/defined_type_handler_spec.rb @@ -1,9 +1,9 @@ require 'spec_helper' -require 'puppetx/puppetlabs/strings/yard/handlers/defined_type_handler' +require 'puppet_x/puppetlabs/strings/yard/handlers/defined_type_handler' require 'strings_spec/parsing' -describe Puppetx::PuppetLabs::Strings::YARD::Handlers::DefinedTypeHandler do +describe PuppetX::PuppetLabs::Strings::YARD::Handlers::DefinedTypeHandler do include StringsSpec::Parsing def the_definedtype() diff --git a/spec/unit/puppetx/puppetlabs/strings/yard/host_class_handler_spec.rb b/spec/unit/puppet_x/puppetlabs/strings/yard/host_class_handler_spec.rb similarity index 89% rename from spec/unit/puppetx/puppetlabs/strings/yard/host_class_handler_spec.rb rename to spec/unit/puppet_x/puppetlabs/strings/yard/host_class_handler_spec.rb index e100fdb..638eaaa 100644 --- a/spec/unit/puppetx/puppetlabs/strings/yard/host_class_handler_spec.rb +++ b/spec/unit/puppet_x/puppetlabs/strings/yard/host_class_handler_spec.rb @@ -1,8 +1,8 @@ require 'spec_helper' -require 'puppetx/puppetlabs/strings/yard/handlers/host_class_handler' +require 'puppet_x/puppetlabs/strings/yard/handlers/host_class_handler' require 'strings_spec/parsing' -describe Puppetx::PuppetLabs::Strings::YARD::Handlers::HostClassHandler do +describe PuppetX::PuppetLabs::Strings::YARD::Handlers::HostClassHandler do include StringsSpec::Parsing def the_hostclass() diff --git a/spec/unit/puppetx/puppetlabs/strings/yard/puppet_3x_function_handler_spec.rb b/spec/unit/puppet_x/puppetlabs/strings/yard/puppet_3x_function_handler_spec.rb similarity index 91% rename from spec/unit/puppetx/puppetlabs/strings/yard/puppet_3x_function_handler_spec.rb rename to spec/unit/puppet_x/puppetlabs/strings/yard/puppet_3x_function_handler_spec.rb index 4ba9e3b..3fa453c 100644 --- a/spec/unit/puppetx/puppetlabs/strings/yard/puppet_3x_function_handler_spec.rb +++ b/spec/unit/puppet_x/puppetlabs/strings/yard/puppet_3x_function_handler_spec.rb @@ -1,8 +1,8 @@ require 'spec_helper' -require 'puppetx/puppetlabs/strings/yard/handlers/puppet_3x_function_handler' +require 'puppet_x/puppetlabs/strings/yard/handlers/puppet_3x_function_handler' require 'strings_spec/parsing' -describe Puppetx::PuppetLabs::Strings::YARD::Handlers::Puppet3xFunctionHandler do +describe PuppetX::PuppetLabs::Strings::YARD::Handlers::Puppet3xFunctionHandler do include StringsSpec::Parsing def the_method() diff --git a/spec/unit/puppetx/puppetlabs/strings/yard/puppet_4x_function_handler_spec.rb b/spec/unit/puppet_x/puppetlabs/strings/yard/puppet_4x_function_handler_spec.rb similarity index 92% rename from spec/unit/puppetx/puppetlabs/strings/yard/puppet_4x_function_handler_spec.rb rename to spec/unit/puppet_x/puppetlabs/strings/yard/puppet_4x_function_handler_spec.rb index d35e33e..14720e3 100644 --- a/spec/unit/puppetx/puppetlabs/strings/yard/puppet_4x_function_handler_spec.rb +++ b/spec/unit/puppet_x/puppetlabs/strings/yard/puppet_4x_function_handler_spec.rb @@ -1,8 +1,8 @@ require 'spec_helper' -require 'puppetx/puppetlabs/strings/yard/handlers/puppet_4x_function_handler' +require 'puppet_x/puppetlabs/strings/yard/handlers/puppet_4x_function_handler' require 'strings_spec/parsing' -describe Puppetx::PuppetLabs::Strings::YARD::Handlers::Puppet4xFunctionHandler do +describe PuppetX::PuppetLabs::Strings::YARD::Handlers::Puppet4xFunctionHandler do include StringsSpec::Parsing def the_method()