pdoc 0.2.0

data/lib/pdoc/models.rb

@@ -0,0 +1,47 @@
+$:.unshift(File.dirname(__FILE__), 'models')
+
+require 'models/base'
+require 'models/entity'
+require 'models/container'
+require 'models/callable'
+require 'models/section'
+require 'models/root'
+require 'models/argument'
+require 'models/class'
+require 'models/class_method'
+require 'models/class_property'
+require 'models/constant'
+require 'models/constructor'
+require 'models/instance_method'
+require 'models/instance_property'
+require 'models/mixin'
+require 'models/namespace'
+require 'models/signature'
+require 'models/utility'
+
+module PDoc
+  module Models
+    class << Models
+      attr_accessor :src_code_href
+      attr_accessor :doc_href
+    end
+    
+    class Base
+      @@subclasses_by_type = {
+        'section' => Section,
+        'argument' => Argument,
+        'class' => Class,
+        'class method' => ClassMethod,
+        'class property' => ClassProperty,
+        'constant' => Constant,
+        'constructor' => Constructor,
+        'instance method' => InstanceMethod,
+        'instance property' => InstanceProperty,
+        'mixin' => Mixin,
+        'namespace' => Namespace,
+        'signature' => Signature,
+        'utility' => Utility
+      }
+    end
+  end
+end

data/lib/pdoc/models/argument.rb

@@ -0,0 +1,37 @@
+module PDoc
+  module Models
+    class Argument < Base
+      attr_reader :name
+      attr_reader :default_value
+      
+      def attach_to_parent(parent)
+        parent.arguments << self
+      end
+      
+      # returns the argument's id in the form
+      # method_id:argument_name. So, for example:
+      # document.querySelectorAll:cssSelector
+      def id
+        @id ||= "#{parent.id}:#{name}"
+      end
+      
+      def optional?
+        !!@optional
+      end
+      
+      def types
+        @types ||= []
+      end
+      
+      def to_hash
+        {
+          :name => name,
+          :description => description,
+          :default_value => default_value,
+          :optional => optional?,
+          :types => types
+        }
+      end
+    end
+  end
+end

data/lib/pdoc/models/base.rb

@@ -0,0 +1,107 @@
+module PDoc
+  module Models
+    class Base
+      @@subclasses_by_type = {}
+      
+      def self.instantiate(attributes)
+        @@subclasses_by_type[attributes['type']].new(attributes)
+      end
+      
+      attr_accessor :parent
+      attr_reader   :description
+      attr_reader   :id
+      attr_reader   :type
+      attr_reader   :file
+      attr_reader   :line_number
+      
+      def initialize(attributes = {})
+        attributes.each { |k, v| instance_variable_set("@#{k}", v) }
+      end
+      
+      def register_on(registry)
+        registry[id] = self
+      end
+      
+      def short_description
+        @short_description ||= description.split(/\n\n/).first
+      end
+      
+      def deprecated?
+        return !!@deprecated if @deprecated
+        parent.respond_to?(:deprecated?) ? parent.deprecated? : false
+      end
+      
+      def full_name
+        @id
+      end
+      
+      def name
+        @name ||= @id.match(/[\w\d\$]+$/)[0]
+      end
+      
+      def ancestor_of?(obj)
+        while obj = obj.parent
+          return true if obj == self
+        end 
+        false
+      end
+      
+      def descendant_of?(obj)
+        obj.ancestor_of?(self)
+      end
+      
+      def doc_href
+        proc = Models.doc_href
+        @doc_href ||= proc ? proc.call(self) : nil
+      end
+      
+      def url(separator = '/')
+        result = []
+        obj = self
+        begin
+          result << obj.normalized_name
+          if obj.is_a?(Models::InstanceMethod) || obj.is_a?(Models::InstanceProperty)
+            result << 'prototype'
+          end
+          obj = obj.parent
+        end until obj.is_a?(Models::Root)
+        result.reverse.join(separator)
+      end
+      
+      def to_hash
+        {
+          :deprecated => deprecated?,
+          :id => id,
+          :type => type,
+          :description => description,
+          :short_description => short_description,
+          :parent => parent.is_a?(Models::Root) ? nil : parent.id,
+          :doc_href => doc_href
+        }
+      end
+      
+      def to_json(*args)
+        to_hash.to_json(*args)
+      end
+      
+      def normalized_name
+        @normalized_name ||= name.gsub(/(^\$+$)|(^\$+)|(\$+$)|(\$+)/) do |m|
+          dollar = Array.new(m.length, 'dollar').join('-')
+          if $1
+            dollar
+          elsif $2
+            "#{dollar}-"
+          elsif $3
+            "-#{dollar}"
+          elsif $4
+            "-#{dollar}-"
+          end
+        end
+      end
+      
+      def inspect
+        "#<#{self.class} #{id}>"
+      end
+    end
+  end
+end

data/lib/pdoc/models/callable.rb

@@ -0,0 +1,19 @@
+module PDoc
+  module Models
+    module Callable
+      def arguments
+        @arguments ||= []
+      end
+      
+      def arguments?
+        @arguments && !@arguments.empty?
+      end
+      
+      def to_hash
+        super.merge({
+          :arguments => arguments
+        })
+      end
+    end
+  end
+end

data/lib/pdoc/models/class.rb

@@ -0,0 +1,28 @@
+module PDoc
+  module Models
+    class Class < Entity
+      include Container
+      attr_accessor :constructor
+      attr_accessor :superclass
+      def attach_to_parent(parent)
+        parent.classes << self
+      end
+      
+      def subclasses
+        @subclasses ||= []
+      end
+      
+      def subclasses?
+        @subclasses && !@subclasses.empty?
+      end
+      
+      def to_hash
+        super.merge({
+          :superclass => superclass,
+          :constructor => constructor,
+          :subclasses => subclasses.map { |obj| obj.id }
+        })
+      end
+    end
+  end
+end

data/lib/pdoc/models/class_method.rb

@@ -0,0 +1,18 @@
+module PDoc
+  module Models
+    class ClassMethod < Entity
+      include Callable
+      attr_accessor :methodized_self
+      def attach_to_parent(parent)
+        parent.class_methods << self
+      end
+      
+      def to_hash
+        m = methodized_self
+        super.merge({
+          :methodized_self => m ? m.id : nil
+        })
+      end
+    end
+  end
+end

data/lib/pdoc/models/class_property.rb

@@ -0,0 +1,9 @@
+module PDoc
+  module Models
+    class ClassProperty < Entity
+      def attach_to_parent(parent)
+        parent.class_properties << self
+      end
+    end
+  end
+end

data/lib/pdoc/models/constant.rb

@@ -0,0 +1,9 @@
+module PDoc
+  module Models
+    class Constant < Entity
+      def attach_to_parent(parent)
+        parent.constants << self
+      end
+    end
+  end
+end

data/lib/pdoc/models/constructor.rb

@@ -0,0 +1,14 @@
+module PDoc
+  module Models
+    class Constructor < Entity
+      include Callable
+      def attach_to_parent(parent)
+        parent.constructor = self
+      end
+      
+      def name
+        @name ||= 'new'
+      end
+    end
+  end
+end

data/lib/pdoc/models/container.rb

@@ -0,0 +1,114 @@
+module PDoc
+  module Models
+    module Container
+      def children
+        @children ||= []
+      end
+      
+      def children?
+        @children && !@children.empty?
+      end
+      
+      # returns an array of Namespace objects belonging to this section
+      def namespaces
+        @namespaces ||= []
+      end
+      
+      def namespaces?
+        @namespaces && !@namespaces.empty?
+      end
+    
+      # returns an array of Class objects belonging to this section
+      def classes
+        @classes ||= []
+      end
+      
+      def classes?
+        @classes && !@classes.empty?
+      end
+    
+      # returns an array of Mixin objects belonging to this section
+      def mixins
+        @mixins ||= []
+      end
+      
+      def mixins?
+        @mixins && !@mixins.empty?
+      end
+      
+      def included_mixins
+        @included_mixins ||= []
+      end
+      
+      def included_mixins?
+        @included_mixins && !@included_mixins.empty?
+      end
+      
+      # returns an array of Function objects belonging to this section
+      def utilities
+        @utilities ||= []
+      end
+      
+      def utilities?
+        @utilities && !@utilities.empty?
+      end
+      
+      # returns an array of constants objects belonging to this section
+      def constants
+        @constants ||= []
+      end
+      
+      def constants?
+        @constants && !@constants.empty?
+      end
+      
+      def class_methods
+        @class_methods ||= []
+      end
+      
+      def class_methods?
+        @class_methods && !@class_methods.empty?
+      end
+      
+      def class_properties
+        @class_properties ||= []
+      end
+      
+      def class_properties?
+        @class_properties && !@class_properties.empty?
+      end
+      
+      def instance_methods
+        @instance_methods ||= []
+      end
+      
+      def instance_methods?
+        @instance_methods && !@instance_methods.empty?
+      end
+      
+      def instance_properties
+        @instance_properties ||= []
+      end
+      
+      def instance_properties?
+        @instance_properties && !@instance_properties.empty?
+      end
+      
+      def to_hash
+        super.merge({
+          :children => children.map { |obj| obj.id },
+          :namespaces => namespaces.map { |obj| obj.id },
+          :classes => classes.map { |obj| obj.id },
+          :mixins => mixins.map { |obj| obj.id },
+          :included_mixins => included_mixins.map { |obj| obj.id },
+          :utilities => utilities.map { |obj| obj.id },
+          :constants => constants.map { |obj| obj.id },
+          :class_methods => class_methods.map { |obj| obj.id },
+          :class_properties => class_properties.map { |obj| obj.id },
+          :instance_methods => instance_methods.map { |obj| obj.id },
+          :instance_properties => instance_properties.map { |obj| obj.id }
+        })
+      end
+    end
+  end
+end

data/lib/pdoc/models/entity.rb

@@ -0,0 +1,54 @@
+module PDoc
+  module Models
+    class Entity < Base
+      attr_accessor :alias
+      
+      def signatures
+        @signatures ||= []
+      end
+      
+      def <=>(other)
+        id.downcase <=> other.id.downcase
+      end
+      
+      def src_code_href
+        proc = Models.src_code_href
+        @src_code_href ||= proc ? proc.call(self) : nil
+      end
+
+      def signatures?
+        @signatures && !@signatures.empty?
+      end
+      
+      def signature
+        @signature ||= signatures.first
+      end
+      
+      def methodized?
+        !!@methodized
+      end
+      
+      def alias?
+        !!@alias
+      end
+      
+      # returns an array of aliases
+      def aliases
+        @aliases ||= []
+      end
+      
+      def aliases?
+        @aliases && !@aliases.empty?
+      end
+      
+      def to_hash
+        super.merge({
+          :aliases => aliases.map { |a| a.id },
+          :alias => self.alias ? self.alias.id : nil,
+          :signatures => signatures,
+          :src_code_href => src_code_href
+        })
+      end
+    end
+  end
+end