puppet-strings 0.4.0 → 0.99.0

metadata

@@ -1,120 +1,143 @@
 --- !ruby/object:Gem::Specification
 name: puppet-strings
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.99.0
 platform: ruby
 authors:
-- Puppet Labs
+- Puppet Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-30 00:00:00.000000000 Z
+date: 2016-10-10 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: puppet
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.7.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.7.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.9.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.9.5
 description: Puppet documentation via YARD
-email: info@puppetlabs.com
+email: info@puppet.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- CHANGELOG.md
+- COMMITTERS.md
+- CONTRIBUTING.md
+- LICENSE
+- README.md
 files:
-- lib/puppet-strings/rake_tasks.rb
+- CHANGELOG.md
+- COMMITTERS.md
+- CONTRIBUTING.md
+- Gemfile
+- JSON.md
+- LICENSE
+- README.md
+- Rakefile
+- lib/puppet-strings.rb
+- lib/puppet-strings/json.rb
+- lib/puppet-strings/tasks.rb
+- lib/puppet-strings/tasks/generate.rb
+- lib/puppet-strings/tasks/gh_pages.rb
+- lib/puppet-strings/yard.rb
+- lib/puppet-strings/yard/code_objects.rb
+- lib/puppet-strings/yard/code_objects/base.rb
+- lib/puppet-strings/yard/code_objects/class.rb
+- lib/puppet-strings/yard/code_objects/defined_type.rb
+- lib/puppet-strings/yard/code_objects/function.rb
+- lib/puppet-strings/yard/code_objects/group.rb
+- lib/puppet-strings/yard/code_objects/provider.rb
+- lib/puppet-strings/yard/code_objects/type.rb
+- lib/puppet-strings/yard/handlers.rb
+- lib/puppet-strings/yard/handlers/puppet/base.rb
+- lib/puppet-strings/yard/handlers/puppet/class_handler.rb
+- lib/puppet-strings/yard/handlers/puppet/defined_type_handler.rb
+- lib/puppet-strings/yard/handlers/puppet/function_handler.rb
+- lib/puppet-strings/yard/handlers/ruby/base.rb
+- lib/puppet-strings/yard/handlers/ruby/function_handler.rb
+- lib/puppet-strings/yard/handlers/ruby/provider_handler.rb
+- lib/puppet-strings/yard/handlers/ruby/type_handler.rb
+- lib/puppet-strings/yard/parsers.rb
+- lib/puppet-strings/yard/parsers/puppet/parser.rb
+- lib/puppet-strings/yard/parsers/puppet/statement.rb
+- lib/puppet-strings/yard/tags.rb
+- lib/puppet-strings/yard/tags/overload_tag.rb
+- lib/puppet-strings/yard/tags/parameter_directive.rb
+- lib/puppet-strings/yard/tags/property_directive.rb
+- lib/puppet-strings/yard/templates/default/fulldoc/html/full_list_puppet_class.erb
+- lib/puppet-strings/yard/templates/default/fulldoc/html/full_list_puppet_defined_type.erb
+- lib/puppet-strings/yard/templates/default/fulldoc/html/full_list_puppet_function.erb
+- lib/puppet-strings/yard/templates/default/fulldoc/html/full_list_puppet_provider.erb
+- lib/puppet-strings/yard/templates/default/fulldoc/html/full_list_puppet_type.erb
+- lib/puppet-strings/yard/templates/default/fulldoc/html/setup.rb
+- lib/puppet-strings/yard/templates/default/layout/html/objects.erb
+- lib/puppet-strings/yard/templates/default/layout/html/setup.rb
+- lib/puppet-strings/yard/templates/default/puppet_class/html/box_info.erb
+- lib/puppet-strings/yard/templates/default/puppet_class/html/header.erb
+- lib/puppet-strings/yard/templates/default/puppet_class/html/overview.erb
+- lib/puppet-strings/yard/templates/default/puppet_class/html/setup.rb
+- lib/puppet-strings/yard/templates/default/puppet_class/html/source.erb
+- lib/puppet-strings/yard/templates/default/puppet_defined_type/html/box_info.erb
+- lib/puppet-strings/yard/templates/default/puppet_defined_type/html/header.erb
+- lib/puppet-strings/yard/templates/default/puppet_defined_type/html/overview.erb
+- lib/puppet-strings/yard/templates/default/puppet_defined_type/html/setup.rb
+- lib/puppet-strings/yard/templates/default/puppet_defined_type/html/source.erb
+- lib/puppet-strings/yard/templates/default/puppet_function/html/box_info.erb
+- lib/puppet-strings/yard/templates/default/puppet_function/html/header.erb
+- lib/puppet-strings/yard/templates/default/puppet_function/html/overview.erb
+- lib/puppet-strings/yard/templates/default/puppet_function/html/setup.rb
+- lib/puppet-strings/yard/templates/default/puppet_function/html/source.erb
+- lib/puppet-strings/yard/templates/default/puppet_provider/html/box_info.erb
+- lib/puppet-strings/yard/templates/default/puppet_provider/html/collection.erb
+- lib/puppet-strings/yard/templates/default/puppet_provider/html/features.erb
+- lib/puppet-strings/yard/templates/default/puppet_provider/html/header.erb
+- lib/puppet-strings/yard/templates/default/puppet_provider/html/overview.erb
+- lib/puppet-strings/yard/templates/default/puppet_provider/html/setup.rb
+- lib/puppet-strings/yard/templates/default/puppet_type/html/box_info.erb
+- lib/puppet-strings/yard/templates/default/puppet_type/html/features.erb
+- lib/puppet-strings/yard/templates/default/puppet_type/html/header.erb
+- lib/puppet-strings/yard/templates/default/puppet_type/html/overview.erb
+- lib/puppet-strings/yard/templates/default/puppet_type/html/parameters.erb
+- lib/puppet-strings/yard/templates/default/puppet_type/html/setup.rb
+- lib/puppet-strings/yard/templates/default/tags/html/puppet_overload.erb
+- lib/puppet-strings/yard/templates/default/tags/setup.rb
 - lib/puppet/application/strings.rb
 - lib/puppet/face/strings.rb
 - lib/puppet/feature/rgen.rb
 - lib/puppet/feature/yard.rb
-- lib/puppet_x/puppetlabs/strings.rb
-- lib/puppet_x/puppetlabs/strings/actions.rb
-- lib/puppet_x/puppetlabs/strings/pops/yard_statement.rb
-- lib/puppet_x/puppetlabs/strings/pops/yard_transformer.rb
-- lib/puppet_x/puppetlabs/strings/util.rb
-- lib/puppet_x/puppetlabs/strings/yard/code_objects/defined_type_object.rb
-- lib/puppet_x/puppetlabs/strings/yard/code_objects/host_class_object.rb
-- lib/puppet_x/puppetlabs/strings/yard/code_objects/method_object.rb
-- lib/puppet_x/puppetlabs/strings/yard/code_objects/provider_object.rb
-- lib/puppet_x/puppetlabs/strings/yard/code_objects/puppet_namespace_object.rb
-- lib/puppet_x/puppetlabs/strings/yard/code_objects/type_object.rb
-- lib/puppet_x/puppetlabs/strings/yard/core_ext/yard.rb
-- lib/puppet_x/puppetlabs/strings/yard/handlers/base.rb
-- lib/puppet_x/puppetlabs/strings/yard/handlers/defined_type_handler.rb
-- lib/puppet_x/puppetlabs/strings/yard/handlers/heredoc_helper.rb
-- lib/puppet_x/puppetlabs/strings/yard/handlers/host_class_handler.rb
-- lib/puppet_x/puppetlabs/strings/yard/handlers/provider_handler.rb
-- lib/puppet_x/puppetlabs/strings/yard/handlers/puppet_3x_function_handler.rb
-- lib/puppet_x/puppetlabs/strings/yard/handlers/puppet_4x_function_handler.rb
-- lib/puppet_x/puppetlabs/strings/yard/handlers/type_handler.rb
-- lib/puppet_x/puppetlabs/strings/yard/json_registry_store.rb
-- lib/puppet_x/puppetlabs/strings/yard/monkey_patches.rb
-- lib/puppet_x/puppetlabs/strings/yard/parser.rb
-- lib/puppet_x/puppetlabs/strings/yard/tags/directives.rb
-- lib/puppet_x/puppetlabs/strings/yard/templates/default/definedtype/html/docstring.erb
-- lib/puppet_x/puppetlabs/strings/yard/templates/default/definedtype/html/header.erb
-- lib/puppet_x/puppetlabs/strings/yard/templates/default/definedtype/html/parameter_details.erb
-- lib/puppet_x/puppetlabs/strings/yard/templates/default/definedtype/html/setup.rb
-- lib/puppet_x/puppetlabs/strings/yard/templates/default/definedtype/setup.rb
-- lib/puppet_x/puppetlabs/strings/yard/templates/default/fulldoc/html/full_list_class.erb
-- lib/puppet_x/puppetlabs/strings/yard/templates/default/fulldoc/html/full_list_puppet_manifest.erb
-- lib/puppet_x/puppetlabs/strings/yard/templates/default/fulldoc/html/full_list_puppet_plugin.erb
-- lib/puppet_x/puppetlabs/strings/yard/templates/default/fulldoc/html/full_list_puppet_provider.erb
-- lib/puppet_x/puppetlabs/strings/yard/templates/default/fulldoc/html/full_list_puppet_type.erb
-- lib/puppet_x/puppetlabs/strings/yard/templates/default/fulldoc/html/setup.rb
-- lib/puppet_x/puppetlabs/strings/yard/templates/default/hostclass/html/box_info.erb
-- lib/puppet_x/puppetlabs/strings/yard/templates/default/hostclass/html/setup.rb
-- lib/puppet_x/puppetlabs/strings/yard/templates/default/hostclass/html/subclasses.erb
-- lib/puppet_x/puppetlabs/strings/yard/templates/default/hostclass/setup.rb
-- lib/puppet_x/puppetlabs/strings/yard/templates/default/html_helper.rb
-- lib/puppet_x/puppetlabs/strings/yard/templates/default/layout/html/setup.rb
-- lib/puppet_x/puppetlabs/strings/yard/templates/default/method_details/html/header.erb
-- lib/puppet_x/puppetlabs/strings/yard/templates/default/method_details/setup.rb
-- lib/puppet_x/puppetlabs/strings/yard/templates/default/method_details/text/header.erb
-- lib/puppet_x/puppetlabs/strings/yard/templates/default/provider/html/command_details.erb
-- lib/puppet_x/puppetlabs/strings/yard/templates/default/provider/html/confine_details.erb
-- lib/puppet_x/puppetlabs/strings/yard/templates/default/provider/html/default_details.erb
-- lib/puppet_x/puppetlabs/strings/yard/templates/default/provider/html/docstring.erb
-- lib/puppet_x/puppetlabs/strings/yard/templates/default/provider/html/feature_details.erb
-- lib/puppet_x/puppetlabs/strings/yard/templates/default/provider/html/header.erb
-- lib/puppet_x/puppetlabs/strings/yard/templates/default/provider/html/setup.rb
-- lib/puppet_x/puppetlabs/strings/yard/templates/default/provider/setup.rb
-- lib/puppet_x/puppetlabs/strings/yard/templates/default/puppetnamespace/html/box_info.erb
-- lib/puppet_x/puppetlabs/strings/yard/templates/default/puppetnamespace/html/header.erb
-- lib/puppet_x/puppetlabs/strings/yard/templates/default/puppetnamespace/html/method_details_list.erb
-- lib/puppet_x/puppetlabs/strings/yard/templates/default/puppetnamespace/html/method_summary.erb
-- lib/puppet_x/puppetlabs/strings/yard/templates/default/puppetnamespace/html/setup.rb
-- lib/puppet_x/puppetlabs/strings/yard/templates/default/puppetnamespace/setup.rb
-- lib/puppet_x/puppetlabs/strings/yard/templates/default/template_helper.rb
-- lib/puppet_x/puppetlabs/strings/yard/templates/default/type/html/docstring.erb
-- lib/puppet_x/puppetlabs/strings/yard/templates/default/type/html/header.erb
-- lib/puppet_x/puppetlabs/strings/yard/templates/default/type/html/parameter_details.erb
-- lib/puppet_x/puppetlabs/strings/yard/templates/default/type/html/provider_details.erb
-- lib/puppet_x/puppetlabs/strings/yard/templates/default/type/html/setup.rb
-- lib/puppet_x/puppetlabs/strings/yard/templates/default/type/setup.rb
-homepage: https://github.com/puppetlabs/puppetlabs-strings
+- spec/acceptance/emit_json_options.rb
+- spec/acceptance/lib/util.rb
+- spec/acceptance/running_strings_generate.rb
+- spec/fixtures/acceptance/modules/test/functions/add.pp
+- spec/fixtures/acceptance/modules/test/lib/puppet/functions/4x_function.rb
+- spec/fixtures/acceptance/modules/test/lib/puppet/parser/functions/function3x.rb
+- spec/fixtures/acceptance/modules/test/lib/puppet/provider/server/linux.rb
+- spec/fixtures/acceptance/modules/test/lib/puppet/type/database.rb
+- spec/fixtures/acceptance/modules/test/manifests/init.pp
+- spec/fixtures/acceptance/modules/test/manifests/triple_nested_classes.pp
+- spec/fixtures/acceptance/modules/test/metadata.json
+- spec/fixtures/unit/json/output.json
+- spec/fixtures/unit/json/output_without_puppet_function.json
+- spec/spec_helper.rb
+- spec/spec_helper_acceptance.rb
+- spec/unit/puppet-strings/json_spec.rb
+- spec/unit/puppet-strings/yard/handlers/puppet/class_handler_spec.rb
+- spec/unit/puppet-strings/yard/handlers/puppet/defined_type_handler_spec.rb
+- spec/unit/puppet-strings/yard/handlers/puppet/function_handler_spec.rb
+- spec/unit/puppet-strings/yard/handlers/ruby/function_handler_spec.rb
+- spec/unit/puppet-strings/yard/handlers/ruby/provider_handler_spec.rb
+- spec/unit/puppet-strings/yard/handlers/ruby/type_handler_spec.rb
+- spec/unit/puppet-strings/yard/parsers/puppet/parser_spec.rb
+homepage: https://github.com/puppetlabs/puppet-strings
 licenses:
 - Apache-2.0
 metadata: {}
@@ -126,17 +149,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-requirements: []
+requirements:
+- puppet, >= 3.7.0
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.2.3
 signing_key: 
 specification_version: 4
 summary: Puppet documentation via YARD
 test_files: []
-has_rdoc: 

data/lib/puppet-strings/rake_tasks.rb

@@ -1,18 +0,0 @@
-require 'rake'
-require 'rake/tasklib'
-require 'puppet/face'
-require 'puppet_x/puppetlabs/strings/util'
-
-namespace :strings do
-  desc 'Generate Puppet documentation with YARD.'
-  task :generate do
-    PuppetX::PuppetLabs::Strings::Util.generate([
-      {emit_json: 'strings.json'}
-    ])
-  end
-
-  desc 'Serve YARD documentation for modules.'
-  task :serve do
-    PuppetX::PuppetLabs::Strings::Util.serve
-  end
-end

data/lib/puppet_x/puppetlabs/strings.rb

@@ -1,64 +0,0 @@
-require 'puppet'
-require 'puppet/pops'
-require 'puppet/util/docs'
-require 'yard'
-
-module PuppetX
-end
-
-# Nothing to see here except forward declarations.
-module PuppetX::PuppetLabs
-  module Strings
-    # This submodule contains bits that operate on the Pops module produced by
-    # the Future parser.
-    module Pops
-      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 'puppet_x/puppetlabs/strings/yard/monkey_patches'
-      require 'puppet_x/puppetlabs/strings/yard/parser'
-
-      module Tags
-        require 'puppet_x/puppetlabs/strings/yard/tags/directives'
-      end
-
-      # This submodule contains code objects which are used to represent relevant
-      # aspects of puppet code in YARD's Registry
-      module CodeObjects
-        require 'puppet_x/puppetlabs/strings/yard/code_objects/puppet_namespace_object'
-        require 'puppet_x/puppetlabs/strings/yard/code_objects/method_object'
-        require 'puppet_x/puppetlabs/strings/yard/code_objects/defined_type_object'
-        require 'puppet_x/puppetlabs/strings/yard/code_objects/host_class_object'
-        require 'puppet_x/puppetlabs/strings/yard/code_objects/type_object'
-        require 'puppet_x/puppetlabs/strings/yard/code_objects/provider_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 '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'
-        require 'puppet_x/puppetlabs/strings/yard/handlers/type_handler'
-        require 'puppet_x/puppetlabs/strings/yard/handlers/provider_handler'
-      end
-
-      ::YARD::Parser::SourceParser.register_parser_type(:puppet,
-        PuppetX::PuppetLabs::Strings::YARD::PuppetParser,
-        ['pp'])
-      ::YARD::Handlers::Processor.register_handler_namespace(:puppet,
-        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.
-      ::YARD::Templates::Engine.register_template_path(
-        File.join(File.dirname(__FILE__), 'strings', 'yard', 'templates'))
-    end
-  end
-end

data/lib/puppet_x/puppetlabs/strings/actions.rb

@@ -1,92 +0,0 @@
-require 'puppet_x/puppetlabs/strings'
-
-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
-  # to YARD
-  def initialize(puppet_debug, puppet_backtrace)
-    @debug = puppet_debug
-    @backtrace = puppet_backtrace
-  end
-
-  # Holds the name of a module and the file path to its YARD index
-  ModuleIndex = Struct.new(:name, :index_path)
-
-
-  # Maps things like the Puppet `--debug` flag to YARD options.
-  def merge_puppet_args!(yard_args)
-    yard_args.unshift '--debug'     if @debug
-    yard_args.unshift '--backtrace' if @backtrace
-
-    yard_args
-  end
-
-  # Builds doc indices (.yardoc directories) for modules.
-  # Currently lacks the fine-grained control over where these
-  # indices are created and just dumps them in the module roots.
-  #
-  # @return [Array<Module>] the modules to be documented
-  #
-  # @param [Array<String>] module_names a list of the module source files
-  # @param [Array<String>] module_sourcefiles default list of module files
-  def index_documentation_for_modules(module_names, module_sourcefiles)
-    # NOTE: The return value of the `module` Face seems to have changed in
-    # 3.6.x. This part of the code will blow up if run under an earlier
-    # version of Puppet.
-    modules = Puppet::Face[:module, :current].list
-    module_list = modules[:modules_by_path].values.flatten
-
-    module_list.select! {|m| module_names.include? m.name} unless module_names.empty?
-
-    # Invoke `yardoc` with -n so that it doesn't generate any HTML output but
-    # does build a `.yardoc` index that other tools can generate output from.
-    yard_args = %w[--no-stats -n] + module_sourcefiles
-    merge_puppet_args!(yard_args)
-
-    module_list.each do |m|
-      Dir.chdir(m.path) do
-        YARD::CLI::Yardoc.run(*yard_args)
-
-        # Clear the global Registry so that objects from one module don't
-        # bleed into the next.
-        YARD::Registry.clear
-      end
-    end
-  end
-
-  # Extracts the needed information of the modules we're documenting
-  #
-  # @return [Array<ModuleIndex>] An array of representation of the modules
-  # to produce documentation for. Each ModuleIndex contains the module name
-  # and the path to its YARD index
-  #
-  # @param [Array<String>] module_list a list of the module source files
-  def generate_module_tuples(module_list)
-    module_list.map do |mod|
-      name = (mod.forge_name || mod.name).gsub('/', '-')
-      yard_index = File.join(mod.path, '.yardoc')
-
-      ModuleIndex.new(name, yard_index)
-    end
-  end
-
-  # Hands off the needed information to YARD so it may
-  # serve the documentation
-  #
-  # @param [Array<String>] yard_args a list of all the arguments to pass to YARD
-  def serve_documentation(*yard_args)
-    merge_puppet_args!(yard_args)
-    YARD::CLI::Server.run(*yard_args)
-  end
-
-  # Hands off the needed information to YARD so it may
-  # generate the documentation
-  #
-  # @param [Array<String>] yard_args a list of all the arguments to pass to YARD
-  def generate_documentation(*yard_args)
-    merge_puppet_args!(yard_args)
-    YARD::CLI::Yardoc.run(*yard_args)
-  end
-end
-

data/lib/puppet_x/puppetlabs/strings/pops/yard_statement.rb

@@ -1,79 +0,0 @@
-require 'ostruct'
-
-# An adapter class that conforms a Pops model instance + adapters to the
-# interface expected by YARD handlers.
-#
-# 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
-  attr_reader :pops_obj, :comments
-
-  def initialize(pops_obj)
-    # Initialize OpenStruct
-    super({})
-
-    unless pops_obj.is_a? Puppet::Pops::Model::PopsObject
-      raise ArgumentError, "A YARDStatement can only be initialized from a PopsObject. Got a: #{pops_obj.class}"
-    end
-
-    @pops_obj = pops_obj
-    @pos_adapter = Puppet::Pops::Adapters::SourcePosAdapter.adapt(@pops_obj)
-    # FIXME: Perhaps this should be a seperate adapter?
-    @comments = extract_comments
-  end
-
-  def type
-    pops_obj.class
-  end
-
-  def line
-    @line ||= @pos_adapter.line
-  end
-
-  def source
-    @source ||= @pos_adapter.extract_text
-  end
-
-  # FIXME: I don't know quite what these are supposed to do, but they show up
-  # quite often in the YARD handler code. Figure out whether they are
-  # necessary.
-  alias_method :show, :source
-  def comments_hash_flag; nil end
-  def comments_range; nil end
-
-  private
-  # TODO: This stuff should probably be part of a separate class/adapter.
-  COMMENT_PATTERN = /^\s*#.*\n/
-
-  def extract_comments
-    comments = []
-    program = pops_obj.eAllContainers.find {|c| c.is_a?(Puppet::Pops::Model::Program) }
-    # FIXME: Horribly inefficient. Multiple copies. Generator pattern would
-    # be much better.
-    source_text = program.source_text.lines.to_a
-
-    source_text.slice(0, line-1).reverse.each do |line|
-      if COMMENT_PATTERN.match(line)
-        # FIXME: The gsub trims comments, but is extremely optimistic: It
-        # assumes only one space separates the comment body from the
-        # comment character.
-        # NOTE: We cannot just trim any amount of whitespace as indentation
-        # is sometimes significant in markdown. We would need a real parser.
-
-        # Comments which begin with some whitespace, a hash and then some
-        # tabs and spaces should be scrubbed. Comments which just have a
-        # solitary hash then a newline should keep that newline since newlines
-        # are significant in markdown.
-        comments.unshift line.gsub(/^\s*#[\t ]/, '').gsub(/^\s*#\n/, "\n")
-      else
-        # No comment found on this line. We must be done piecing together a
-        # comment block.
-        break
-      end
-    end
-
-    # Stick everything back together.
-    comments.join
-  end
-end