Contents

require "jsduck/util/singleton"

module JsDuck
  module Js

    # Auto-detection of properties.
    class Property
      include Util::Singleton

      # Checks if AST node is a property, and if so, returns doc-hash
      # with property name and various auto-detected attributes.
      # When not a property returns nil.
      def detect(ast)
        exp = ast.expression_statement? ? ast["expression"] : nil
        var = ast.variable_declaration? ? ast["declarations"][0] : nil

        # foo = ...
        if exp && exp.assignment_expression?
          make(exp["left"].to_s, exp["right"])

          # var foo = ...
        elsif var
          make(var["id"].to_s, var["init"])

          # foo: ...
        elsif ast.property?
          make(ast["key"].key_value, ast["value"])

          # foo;
        elsif exp && exp.identifier?
          make(exp.to_s)

          # "foo"  (inside some expression)
        elsif ast.string?
          make(ast.to_value)

          # "foo";  (as a statement of it's own)
        elsif exp && exp.string?
          make(exp.to_value)

          # Object.defineProperty(obj, "prop", {value: x})
        elsif exp && exp.define_property?
          name = exp["arguments"][1].to_value
          writable = exp.object_descriptor("writable")
          readonly = writable ? !writable.to_value : true
          make(name, exp.object_descriptor("value"), readonly)

        else
          nil
        end
      end

      # Produces a doc-hash for a property.
      def make(name=nil, ast=nil, readonly=nil)
        return {
          :tagname => :property,
          :name => name,
          :type => ast && ast.value_type,
          :default => ast && default(ast),
          :readonly => readonly,
        }
      end

      private

      def default(ast)
        ast.to_value != nil ? ast.to_s : nil
      end

    end
  end
end

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
jsduck-5.2.0	lib/jsduck/js/property.rb
jsduck-5.1.0	lib/jsduck/js/property.rb
jsduck-5.0.1	lib/jsduck/js/property.rb