Merge pull request #25 from hkenney/issue/master/PDOC-26_update_puppe…

…tx_module_name

(PDOC-26) Rename Puppetx to PuppetX

lib/puppet/face/strings.rb

@@ -33,9 +33,9 @@ def check_required_features
 
     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 @@ def check_required_features
 
     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
 

lib/puppetx/puppetlabs/strings.rb → 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.

lib/puppetx/puppetlabs/strings/actions.rb → 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

lib/puppetx/puppetlabs/strings/pops/yard_statement.rb → lib/puppet_x/puppetlabs/strings/pops/yard_statement.rb

@@ -6,7 +6,7 @@
 # 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)

lib/puppetx/puppetlabs/strings/pops/yard_transformer.rb → 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 @@ def transform_Program(o)
   # 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 @@ def transform_NamedDefinition(o)
 
   # 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!

lib/puppetx/puppetlabs/strings/yard/code_objects/defined_type_object.rb → 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<Array(String, String)>]
   attr_accessor :parameters

lib/puppetx/puppetlabs/strings/yard/code_objects/host_class_object.rb → lib/puppet_x/puppetlabs/strings/yard/code_objects/host_class_object.rb

@@ -1,12 +1,12 @@
-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
 
   # 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)

lib/puppetx/puppetlabs/strings/yard/code_objects/puppet_namespace_object.rb → 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)

lib/puppetx/puppetlabs/strings/yard/handlers/base.rb → 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}

lib/puppetx/puppetlabs/strings/yard/handlers/defined_type_handler.rb → 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

lib/puppetx/puppetlabs/strings/yard/handlers/host_class_handler.rb → 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

lib/puppetx/puppetlabs/strings/yard/handlers/puppet_3x_function_handler.rb → 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)
 

lib/puppetx/puppetlabs/strings/yard/handlers/puppet_4x_function_handler.rb → 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)
 

lib/puppetx/puppetlabs/strings/yard/parser.rb → lib/puppet_x/puppetlabs/strings/yard/parser.rb

@@ -1,18 +1,18 @@
 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)
     @source = source
     @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

spec/spec_helper.rb

@@ -5,7 +5,7 @@
 require 'puppet'
 require 'rspec'
 
-require 'puppetx/puppetlabs/strings'
+require 'puppet_x/puppetlabs/strings'
 
 RSpec.configure do |config|
     config.mock_with :mocha

spec/unit/puppetx/puppetlabs/strings/pops_spec.rb → 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 "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

spec/unit/puppetx/puppetlabs/strings/yard/defined_type_handler_spec.rb → 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()

spec/unit/puppetx/puppetlabs/strings/yard/host_class_handler_spec.rb → 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()

spec/unit/puppetx/puppetlabs/strings/yard/puppet_3x_function_handler_spec.rb → 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()

spec/unit/puppetx/puppetlabs/strings/yard/puppet_4x_function_handler_spec.rb → 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()