Contents

module Inch
  module CodeObject
    # Provider modules "provide" a Codebase object with code objects.
    # They are the intermediary between the raw representation that tools
    # like YARD deliver and the "interface" that Inch expects.
    #
    # YARD Example:
    #
    # YARD's SourceParser returns ::YARD::CodeObject objects, which are
    # cast to Provider::YARD::Object::Base objects that can ensure naming
    # conventions et al. follow certain rules. These objects are then again
    # converted into CodeObject::Proxy::Base objects that form the codebase:
    #
    #                        ::YARD::CodeObject
    #                               ↓
    #           ::Inch::CodeObject::Provider::YARD::Object::Base
    #                               ↓
    #                             (Hash)
    #                               ↓
    #                   ::Inch::CodeObject::Proxy::Base
    #
    #
    module Provider
      def self.parse(dir, config = Inch::Config.codebase, type = :YARD)
        provider_for(type).parse(dir, config)
      end

      # @return [Module]
      def self.provider_for(type)
        const_get(type)
      end
    end
  end
end

require "inch/code_object/provider/yard"

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
inch-0.4.10	lib/inch/code_object/provider.rb
inch-0.4.9	lib/inch/code_object/provider.rb
inch-0.4.8	lib/inch/code_object/provider.rb
inch-0.4.7	lib/inch/code_object/provider.rb