Contents

require 'lazydoc'

module Lazydoc
  # Attributes adds methods to declare class-level accessors for Lazydoc 
  # attributes.
  #
  #   # ConstName::key value
  #   class ConstName
  #     extend Lazydoc::Attributes
  #
  #     lazy_attr :key
  #   end
  #
  #   ConstName.source_file            # =>  __FILE__
  #   ConstName::key.subject           # => 'value'
  # 
  module Attributes

    # The source_file for self.  By default set to the file where
    # Attributes extends a class (if you include Attributes, you
    # must set source_file manually).
    attr_accessor :source_file
    
    def self.extended(base) # :nodoc:
      caller[1] =~ CALLER_REGEXP
      base.source_file ||= $1
    end

    # Returns the lazydoc for source_file
    def lazydoc(resolve=true)
      lazydoc = Lazydoc[source_file]
      lazydoc.resolve if resolve
      lazydoc
    end

    # Creates a lazy attribute accessor for the specified attribute.
    def lazy_attr(key, attribute=key)
      instance_eval %Q{
def #{key}
  lazydoc[to_s]['#{attribute}'] ||= Lazydoc::Comment.new
end

def #{key}=(comment)
  Lazydoc[source_file][to_s]['#{attribute}'] = comment
end}
    end
    
    # Registers the next method.
    def register_method___(comment_class=Method)
      lazydoc(false).register___(comment_class, 1)
    end
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
lazydoc-0.2.0	lib/lazydoc/attributes.rb