Contents

require 'json'
require 'inch/language/javascript/provider/jsdoc/object'

module Inch
  module Language
    module JavaScript
      module Provider
        module JSDoc
          # Parses the source tree (using JSDoc)
          class Parser
            # TODO: should we remove constant and namespace from this list?
            IGNORE_TYPES = %w(event external file interface member mixin package param constant namespace)

            attr_reader :parsed_objects

            # Helper method to parse an instance with the given +args+
            #
            # @see #parse
            # @return [CodeObject::Provider::JSDoc::Parser] the instance that
            #   ran
            def self.parse(*args)
              parser = new
              parser.parse(*args)
              parser
            end

            # @param dir [String] directory
            # @param config [Inch::Config::Codebase] configuration for codebase
            # @return [void]
            def parse(dir, config)
              Dir.chdir(dir) do
                parse_objects(config.included_files, config.excluded_files,
                              config.read_dump_file)
              end
            end

            # @return [Array<YARD::Object::Base>]
            def objects
              @objects ||= parsed_objects.map do |o|
                JSDoc::Object.for(o) unless IGNORE_TYPES.include?(o['kind'])
              end.compact
            end

            private

            def parse_objects(_paths, _excluded, read_dump_file = nil)
              if read_dump_file.nil?
                fail 'JavaScript analysis only works with --read-from-dump.'
              else
                output = File.read(read_dump_file, :encoding => 'utf-8')
              end
              @parsed_objects = JSON[output]['objects']
            end
          end
        end
      end
    end
  end
end

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
inch-0.6.0.rc5	lib/inch/language/javascript/provider/jsdoc/parser.rb
inch-0.6.0.rc4	lib/inch/language/javascript/provider/jsdoc/parser.rb